diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..cd3a37c3 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,14 @@ +# Contributing + +If you wish to contribute to the HMCCosmetics codebase, feel free to fork the repository and [submit a pull request](https://github.com/HibiscusMC/HMCCosmetics/compare). +> **Note** Contributions to the HMCCosmetics codebase should remain consistent with current coding style. You should avoid messy or confusing code. Remember to keep your code clean, documented and understandable. + +## Setup + +To get ready to work on the codebase, please do the following: + +1. Fork & clone the repository, and make sure you're on the **remapped** branch. (*This is the default branch*) +2. Code your heart out! +3. Run `./gradlew build` to ensure your project sucessfully builds. +> **Note** This may take a while +4. Finally, [submit a pull request](https://github.com/HibiscusMC/HMCCosmetics/compare)!