From bc49991411c5bf8158d2d2e79ad7e12bf7cd7bcf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivan=20=E2=80=9CCLOVIS=E2=80=9D=20Canet?= Date: Mon, 18 Sep 2023 21:04:46 +0200 Subject: [PATCH] docs: Add a contributing guide which lists issue labels --- CONTRIBUTING.md | 77 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 7 ++--- 2 files changed, 80 insertions(+), 4 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0b5fe06 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,77 @@ +# Contributing to this project + +Thanks for wanting to contribute to the project! + +There are many things we appreciate help with. The simplest is to report problems you see in the documentation or while using the project, by creating an issue. + +If you have a specific change you'd like to submit, be it documentation, bug fixes or new features, please read our guide on [how to create merge requests following our conventions](https://gitlab.com/opensavvy/wiki/-/blob/main/README.md#wiki). + +> Before starting making large changes, please do talk about it with us! Some things, in particular, deploying to new platforms requires changes on our side as well. + +## Issue tracking + +If you want to contribute, but do not know what to improve, we recommend going through to existing issues. +We assign labels to issues to make them easier to find. + +If you're reading this page in GitLab, the labels should appear in color and be clickable. +If you're reading this on another tool, you can search by label in the issue list. + +**Labels common to all OpenSavvy projects** + +
+Issue type + +- ~feature: High-level feature/use-case description (implementation is split into multiple sub-issues). +- ~discussion: More discussion is required before classification or implementation can be started. +- ~deployment: Issues related to deployment, CI/CD or other kinds of automation. +- ~documentation: Documentation improvements or problems. +- ~bug: Something does not behave as expected. +- ~security: Security risk to users of the project. +- ~incident: Deployment issue (the website is down…). +- ~wontfix: We decided that this issue is out of scope for the project, or cannot be done. +- ~blocked-externally: We cannot go further on this topic, because some external service/library we depend on has a bug/is missing a feature. + +
+
+Contribution difficulty + +These labels are indicators of how hard we think it is to implement them for an external contributor. +We do not always label issues by contribution difficulty. If you are interested in an issue that isn't labelled, don't hesitate to write a comment communicating your interest and asking for precision. + +- ~contribution::easy: Issues that are well explained and require little project knowledge. +- ~contribution::medium: Issues that are well explained, but require some project knowledge. +- ~contribution::difficult: Issues that are well explained, but require a strong understanding of the project. + +
+
+Priority + +- ~priority::low: Implementation is not time-sensitive. +- ~priority::medium: Normal priority. +- ~priority::high: We want to do this soon. +- ~priority::urgent: We want to do this as soon as possible. + +
+
+Severity (only for bugs and incidents) + +- ~severity::cosmetic: Some parts of the project do not look as good as they could, or there is a minor error in documentation. Usage is not impacted. +- ~severity::minor: Some parts of the project are inconvenient to use. +- ~severity::moderate: Some parts of the project cannot be used. +- ~severity::major: Some important parts of the project cannot be used. +- ~severity::critical: The entire project cannot be used. + +
+
+Development state (issues only) + +We do not always use these labels. When in doubt, write a comment asking for precision. +These labels should only be applied to issues, not merge requests. + +- ~issue::doing: Someone is currently working on it. +- ~issue::review: A merge request exists that will close this issue, and it's entered the review cycle. + +
+ + + diff --git a/README.md b/README.md index c76a567..cde119c 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,6 @@ This a template to easily bootstrap your projects. ## Contributing -This project follows the OpenSavvy workflow and code conventions. -To learn how to contribute, please read [our wiki](https://gitlab.com/opensavvy/wiki/-/blob/main/README.md). - -This project also uses the [OpenSavvy Playground](docs/playground/README.md). +See [CONTRIBUTING.md](CONTRIBUTING.md). +- To learn more about our coding conventions and workflow, see the [OpenSavvy Wiki](https://gitlab.com/opensavvy/wiki/-/blob/main/README.md#wiki). +- This project is based on the [OpenSavvy Playground](docs/playground/README.md), a collection of preconfigured project templates. -- 2.51.2