diff --git a/README.md b/README.md index 5514f580e..f27e762b9 100644 --- a/README.md +++ b/README.md @@ -58,3 +58,17 @@ Quick description of the content in the root folder: |-- androidTest -- Source tree for Android implementation tests |-- test -- Source tree for Java JUnit tests + +## How to contribute +If you’re new to ODK-X you can check out the documentation: +- [https://docs.odk-x.org](https://docs.odk-x.org) + +Once you’re up and running, you can choose an issue to start working on from here:  +- [https://github.com/odk-x/tool-suite-X/issues](https://github.com/odk-x/tool-suite-X/issues) + +Issues tagged as [good first issue](https://github.com/odk-x/tool-suite-X/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) should be a good place to start. + +Pull requests are welcome, though please submit them against the development branch. We prefer verbose descriptions of the change you are submitting. If you are fixing a bug please provide steps to reproduce it or a link to a an issue that provides that information. If you are submitting a new feature please provide a description of the need or a link to a forum discussion about it. + +## Links for users +This document is aimed at helping developers and technical contributors. For information on how to get started as a user of ODK-X, see our [online documentation](https://docs.odk-x.org), or to learn more about the Open Data Kit project, visit [https://odk-x.org](https://odk-x.org).