From 46604a9a3320026a9dd47b85775955e3597eef97 Mon Sep 17 00:00:00 2001 From: matt-hagemann Date: Wed, 4 Oct 2023 17:17:23 +0200 Subject: [PATCH] wip --- README.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 63af320..51d8243 100644 --- a/README.md +++ b/README.md @@ -1 +1,34 @@ -# Ubuntu App Ratings Service +# Welcome to Ratings + +[actions-image]: https://github.com/ubuntu/app-center-ratings/actions/workflows/test.yaml/badge.svg?branch=main +[actions-url]: https://github.com/ubuntu/app-center-ratings/actions?query=branch%3Amain+event%3Apush + +[license-image]: https://img.shields.io/badge/License-GPL3.0-blue.svg + +[codecov-image]: https://codecov.io/gh/ubuntu/app-center-ratings/branch/dev/graph/badge.svg +[codecov-url]: https://codecov.io/gh/ubuntu/app-center-ratings + +[![Code quality][actions-image]][actions-url] +[![License][license-image]](LICENSE) +[![Code coverage][codecov-image]][codecov-url] + +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). + +## Troubleshooting + +TODO: Add details on how to debug this project, where to increase verbosity, how to find logs, how to run in debug mode. + +## Get involved + +This is an [open source](LICENSE) project and we warmly welcome community contributions, suggestions, and constructive feedback. If you're interested in contributing, please take a look at our [Contribution guidelines](CONTRIBUTING.md) first. + +- to report an issue, please file a bug report against our repository, using a bug template. +- for suggestions and constructive feedback, report a feature request bug report, using the proposed template. + +## 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).