CONTRIBUTING.md (#157)

* Draft CONTRIBUTING.md

* Expand PR process; mention KZ

* More TODO

* Add notes about documenting

* Address (most) PR comments

* Finish responding to PR comments; add PR template

* Fix grammar

* Add missing periods. More actor examples. Remove ref to booleans

* Add note about `NON_EQUIVALENT`; bold asset warning

* Condense PR template

* PR feedback from Kenix; Condense PR template

* Incorporate Thar0's feedback
This commit is contained in:
Zach Banks
2021-05-20 21:06:30 -04:00
committed by GitHub
parent 062a813fba
commit 8c62c102cf
3 changed files with 187 additions and 4 deletions
+9
View File
@@ -0,0 +1,9 @@
Before opening this PR, ensure the following:
- `./format.sh` was run to apply standard formatting.
- `make` successfully builds a matching ROM.
- No new compiler warnings were introduced during the build process.
- Can be verified locally by running `tools/warnings_count/check_new_warnings.sh`
- New variables & functions should follow standard naming conventions.
- Comments and variables have correct spelling.
---
<!-- Leave the text above intact. Add additional comments below. -->