ShuriZma
/
project64
mirror of https://github.com/project64/project64.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md (#2341) 

Added a detailed guide on how to properly contribute code to the project through GitHub.
This commit is contained in:
Dongni31 2023-02-20 23:26:02 -05:00 committed by GitHub
parent 1864adcb35
commit 47ecc12b77
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
.github/CONTRIBUTING.md vendored
View File

@ -8,4 +8,21 @@ Following these guidelines will help make sure that users and developers alike c
Please do NOT post any copyrighted materials. This includes (but is not limited to) ROMs, ROM hacks, IPL and firmware files, etc.
Save states and game saves do not fall under this category, so please post them if they are applicable to your issue!
Save states and game saves do not fall under this category, so please post them only if they are applicable to your issue!
# Github Contribution Guide
1. Create a frok of the repository on your own account.
2. Create a new branch from the `develop` branch.
* Use helpful naming convention for the branch. (i.e. `fix`, `documentation`, etc.)
3. Commit the changes made on your new branch
4. If senisible, squash all of your commits into one. This will help clean up the process of vetting.
* Esnure that commit messages are clear, consice, and infromative. They should include information about all changes made especially if you've squash multiple commits into one.
5. Once all commits have been made and squashed, rebase all changes in your branch.
* Rebasing will resolve any merge confilcts that your changes may present
7. Create a pull request to the `develop` branch
* The Pull request should be descriptive including any and all changes made to the code base. If multiple files have been changed, then organize the changes in a manner that is easy for a reviewer to follow.
* Make sure that you **allow edits** by maintainers when making the Pull Request
8. Your changes should be reviewed and fixes may be made to your changes.
* If fixes are made please make sure to address them