diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7a02188 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ +# Contributing to Game of Life + +Contribution to this project is welcome + +## General Guidelines + +Please read the [Code of Conduct](./CODE_OF_CONDUCT.md)<br/> +Please read these blog posts (which frame the philosophies that we are trying to follow, to keep things simple/clean and maintainable) + +- [Write code that is easy to delete, not easy to extend](https://programmingisterrible.com/post/139222674273/write-code-that-is-easy-to-delete-not-easy-to) +- [Write code that is easy to delete, and easy to debug too](https://programmingisterrible.com/post/173883533613/code-to-debug) +- [Repeat yourself, do more than one thing, and rewrite everything](https://programmingisterrible.com/post/176657481103/repeat-yourself-do-more-than-one-thing-and) + +## Contribute to the code base + +1. Fork this repository to your own account and then clone it to your local device. +2. Create a new branch `git checkout -b MY_BRANCH_NAME` +3. Install the dependencies based on which language you are modifying (or adding support to). +4. Do your changes. +5. Run the tests bundled with the language. +6. Commit your changes and push them. +7. Create a pull/merge request. +8. Thanks in advance for your contribution :) |