summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
blob: a44e3fb89b87f203700b4886724bfb34eeded85d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# 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 

- [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. Clone the repo.
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.
7. Prepare a patchset (or `git send-email`)
8. Thanks in advance for your contribution :) 

## Report Issues
-  Submit a ticket at https://todo.sr.ht/~a14m/game-of-life