From 31189cc9b3891a6049478e955a47589ce964265d Mon Sep 17 00:00:00 2001
From: Kenix3 <kenixwhisperwind@gmail.com>
Date: Mon, 29 May 2023 01:42:11 -0400
Subject: [PATCH] Adds CONTRIBUTING.md (#295)

* Adds email address to CODE_OF_CONDUCT.md

* Adds CONTRIBUTING.md

* Removes clang-format text from README.md

* Fixes typo in CONTRIBUTING.md file link.
---
 CODE_OF_CONDUCT.md |  2 +-
 CONTRIBUTING.md    | 19 +++++++++++++++++++
 README.md          | 11 +++++------
 3 files changed, 25 insertions(+), 7 deletions(-)
 create mode 100644 CONTRIBUTING.md

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
index d33878e14..e893f1ac2 100644
--- a/CODE_OF_CONDUCT.md
+++ b/CODE_OF_CONDUCT.md
@@ -61,7 +61,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-[INSERT CONTACT METHOD].
+kenixwhisperwind@gmail.com.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 000000000..8f9c3570e
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,19 @@
+# Preface
+LUS accepts any and all contributions. You can interact with the project via PRs, issues, email (kenixwhisperwind@gmail.com), or [Discord](https://discord.gg/RQvdvavB).
+
+# Code of Conduct
+Please review and abide by our [code of conduct](https://github.com/Kenix3/libultraship/blob/main/CODE_OF_CONDUCT.md).
+
+# Building
+Please see the [readme](https://github.com/Kenix3/libultraship/blob/main/README.md) for building instructions.
+
+# Pull Requests
+## Procedures
+Our CI system will automatically check your PR to ensure that it fits [formatting guidelines](https://github.com/Kenix3/libultraship/blob/main/.clang-format), [linter guidelines](https://github.com/Kenix3/libultraship/blob/main/.clang-tidy), and that the code builds. The submitter of a PR is required to ensure their PR passes all CI checks. The submitter of the PR is encouraged to address all PR review comments in a timely manner to ensure a timely merge of the PR.
+### Troubleshooting CI Errors
+#### tidy-format-validation
+If the tidy-format-validation check fails, then you need to run clang-format. Below is a command that can be used on Linux. Most modern IDEs have a clang-format plugin that can be used. The [.clang-format file can be found here](https://github.com/Kenix3/libultraship/blob/main/.clang-format)
+##### Running clang-format
+```
+find src include -name "*.cpp" -o -name "*.h" | sed 's| |\\ |g' | xargs clang-format-12 -i
+```
diff --git a/README.md b/README.md
index b5be1157d..470680410 100644
--- a/README.md
+++ b/README.md
@@ -3,8 +3,12 @@ libultraship (LUS) is a library meant to provide reimplementations of libultra (
 
 LUS uses an asset loading system where data is stored separately from the executable in an archive file ending in `.otr`, which is an [`.mpq`](http://www.zezula.net/en/mpq/main.html) compatible file. This separation the data from the executable follows modern design practices and that it is more mod friendly. All one needs to do is supply a patch `.otr` and the system will automatically replace the data.
 
+## Contributing
+LUS accepts any and all contributions. You can interact with the project via PRs, issues, email (kenixwhisperwind@gmail.com), or [Discord](https://discord.gg/RQvdvavB).
+Please see [CONTRIBUTING.md](https://github.com/Kenix3/libultraship/blob/main/CONTRIBUTING.md) file for more information.
+
 ## Versioning
-We use semantic versioning. We have defined the API as `every C linkage function, variable, struct, class, public class method, or enum included from libultraship.h`.
+We use semantic versioning. We have defined the API as: every C linkage function, variable, struct, class, public class method, or enum included from libultraship.h.
 
 ## Building on Linux/Mac
 ```
@@ -25,11 +29,6 @@ cmake --build build
 & 'C:\Program Files\CMake\bin\cmake' --build .\build\x64
 ```
 
-## Running clang-format
-```
-find src include -name "*.cpp" -o -name "*.h" | sed 's| |\\ |g' | xargs clang-format-12 -i
-```
-
 ## Sponsors
 Thankyou to JetBrains for providing their IDE [CLion](https://www.jetbrains.com/clion/) to me for free!