From 62043d309385583e830675f868f9bdce7f931ae2 Mon Sep 17 00:00:00 2001 From: jdxyw Date: Tue, 23 Mar 2021 10:29:59 +0800 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6f730d4 --- /dev/null +++ b/CONTRIBUTING.md @@ -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).