aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorRon Evans <[email protected]>2019-02-05 18:25:19 +0100
committerGitHub <[email protected]>2019-02-05 18:25:19 +0100
commitf0091b31b57dc42ec2fbe7d42f5ff86b51d67fd3 (patch)
tree7fbbf60584ee29ed15cf2b8577572d83caf41c4c
parent709a2961507c0d28a86384c9867e6faec6b5d078 (diff)
downloadtinygo-f0091b31b57dc42ec2fbe7d42f5ff86b51d67fd3.tar.gz
tinygo-f0091b31b57dc42ec2fbe7d42f5ff86b51d67fd3.zip
Add CONTRIBUTING.md to help us help you (#169)
* docs: add contributing guidelines to make it easier to help the project Signed-off-by: Ron Evans <[email protected]> * docs: add info about Slack channel to contributing guidelines Signed-off-by: Ron Evans <[email protected]>
-rw-r--r--CONTRIBUTING.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 000000000..1d380854f
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,42 @@
+# How to contribute
+
+Thank you for your interest in improving TinyGo.
+
+We would like your help to make this project better, so we appreciate any contributions. See if one of the following descriptions matches your situation:
+
+### New to TinyGo
+
+We'd love to get your feedback on getting started with TinyGo. Run into any difficulty, confusion, or anything else? You are not alone. We want to know about your experience, so we can help the next people. Please open a Github issue with your questions, or you can also get in touch directly with us on our Slack channel at [https://gophers.slack.com/messages/CDJD3SUP6](https://gophers.slack.com/messages/CDJD3SUP6).
+
+### Something in TinyGo is not working as you expect
+
+Please open a Github issue with your problem, and we will be happy to assist.
+
+### Something in Go that you want/need does not appear to be in TinyGo
+
+We probably have not implemented it yet. Please take a look at our [Roadmap](https://github.com/tinygo-org/tinygo/wiki/Roadmap). Your pull request adding the functionality to TinyGo would be greatly appreciated.
+
+### Some specific hardware you want to use does not appear to be in TinyGo
+
+As above, we probably have not implemented it yet. Your contribution adding the hardware support to TinyGo would be greatly appreciated.
+
+## How to use our Github repository
+
+The `master` branch of this repo will always have the latest released version of TinyGo. All of the active development work for the next release will take place in the `dev` branch. TinyGo will use semantic versioning and will create a tag/release for each release.
+
+Here is how to contribute back some code or documentation:
+
+- Fork repo
+- Create a feature branch off of the `dev` branch
+- Make some useful change
+- Make sure the tests still pass
+- Submit a pull request against the `dev` branch.
+- Be kind
+
+## How to run tests
+
+To run the tests:
+
+```
+make test
+```