From 3e6f4f6bb168bff634009dc041baa898388bb604 Mon Sep 17 00:00:00 2001 From: Ronan Pearce Date: Tue, 22 Sep 2015 14:03:41 +0100 Subject: [PATCH] Add Initial contributing doc. --- CONTRIBUTING.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..51c20b7d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Contributing + +We welcome pull requests from everyone. By contributing to this project, you agree to abide by the Fungus [code of conduct]. You also agree that by submitting a pull request for this project, *your contribution will be licensed under the MIT license for this project*. + +Fork and clone the Fungus repo (see [fork a repo] ) + +Make sure the tests pass locally (more information on how to do this coming soon). + +Make your change. Add tests for your change. Make the tests pass locally. + +Push to your fork and [submit a pull request][pr]. + +[pr]: https://github.com/fungusgames/Fungus/compare/ + +We will try to give initial feedback to pull requests within 3 days or sooner. However, this may not always be possible. Please be patient, we will look at every pull request as soon as we can. + +Your pull request will have a better chance of being accepted if you do the following: + +* Write tests (more information on how to do this coming soon). +* Follow our coding style (details coming soon !) +* Write a [good commit message][commit]. + +[code of conduct]: https://fungusgames.com/code-of-conduct +[commit]: http://chris.beams.io/posts/git-commit/ +[fork a repo]: https://help.github.com/articles/fork-a-repo/