diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 77d82cd..d9065cc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -59,6 +59,16 @@ In general, we follow the ["fork-and-pull" Git workflow](https://github.com/susa Once merged to the main branch, `po` files and any documentation change will be automatically updated. Those are thus not necessary in the pull request itself to minimize diff review. +## Contributing to the code + +### Required dependencies + +TODO + +### Building and running the binaries + +TODO + ### About the testsuite The project includes a comprehensive testsuite made of unit and integration tests. All the tests must pass before the review is considered. If you have troubles with the testsuite, feel free to mention it on your PR description. diff --git a/README.md b/README.md index 8b6e72d..00e00a7 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ This is the code repository for **Ratings**, the backend service responsible for managing the new vote and rating system used in [App Center](https://github.com/ubuntu/app-center) -For general details, including installation and getting started, head over to our [setup documentation](HACKING.md). +For general details, including installation, getting started and setting up a development environment, head over to our section on [Contributing to the code](CONTRIBUTING.md#contributing-to-the-code). ## Get involved @@ -22,3 +22,9 @@ This is an [open source](LICENSE) project and we warmly welcome community contri - To report an issue, please file a bug report against our repository. - For suggestions and constructive feedback, please file a feature request or a bug report. + +## Get in touch + +We're friendly! We have a community forum at [https://discourse.ubuntu.com](https://discourse.ubuntu.com) where we discuss feature plans, development news, issues, updates and troubleshooting. + +For news and updates, follow the [Ubuntu twitter account](https://twitter.com/ubuntu) and on [Facebook](https://www.facebook.com/ubuntu).