Create CONTRIBUTING.md
This commit is contained in:
parent
b9992995db
commit
62043d3093
1 changed files with 16 additions and 0 deletions
16
CONTRIBUTING.md
Normal file
16
CONTRIBUTING.md
Normal file
|
@ -0,0 +1,16 @@
|
||||||
|
I love to see contributions to the project and have tried to make it easy to do so. If you would like to contribute code to this project you can do so through GitHub by forking the repository and opening a pull request. Please feel free to open the PRs or issues you want.
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
If you contribute anything, please add the necessary documentations.
|
||||||
|
|
||||||
|
- If you add new type of art, add documentation under the folder `docs` and the `README.md`.
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
If you add new art, please add a new example under the folder `example`. And write the necessay documentation under the folder [docs](https://github.com/jdxyw/generativeart/tree/master/docs) and the [README.md](https://github.com/jdxyw/generativeart/blob/master/README.md).
|
||||||
|
|
||||||
|
## Code
|
||||||
|
|
||||||
|
- Add concise and detailed comments.
|
||||||
|
- The code style shold follow the [Go Code Review Comments](https://code.google.com/p/go-wiki/wiki/CodeReviewComments).
|
Loading…
Reference in a new issue