Repo-Mirror/HMCCosmetics
9
0
Fork 0
mirror of https://github.com/HibiscusMC/HMCCosmetics.git synced 2025-12-22 16:39:21 +00:00
Code Issues Releases Activity

github: add contribution guide

Browse Source
This commit is contained in:
Craftinators
2023-04-05 22:07:16 -04:00
parent 0b4815842f
commit 1e27933573
1 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
.github/CONTRIBUTING.md vendored Normal file
View File

@@ -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)!