diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0791ad5..0b7db0b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,6 +21,46 @@ Before pulling merge requests, you will have to read the [contributing guideline ## Contributing guidelines +Before contributing, you will have to read the contributing guidelines as we will **not** accept your request +if you do not respect our community guidelines. + #### Filing an issue +When filing an issue, you will have to fill the skeleton of the ebuild in quotes: + +``` +EAPI=7 + +DESCRIPTION="" +HOMEPAGE="" +SRC_URI="" + +LICENSE="" +``` + +After this, you can safely file the issue, and we will take care of it. + #### Pulling Merge Requests + +When committing and/or pulling merge requests, you will have to respect our +Committing & Pulling Merge Requests System (CnPMRS) +so we can easily identify the changes: + +- Provide us the Manifest file; +- Follow the committing & pulling merge request layout (below). + +Each commit will have to be based on this layout: + +`[CATEGORY]/[PACKAGE_NAME]: [COMMIT_MESSAGE]` + +For example, if the package is called **mail-client/freelook-bin**, +and you have added this package, the commit or merge request should look like this: + +`mail-client/freelook-bin: add freelook-bin-[PACKAGE_VERSION]` # e.g. 1.0.0 + +For example, if the package is called **mail-client/freelook-bin**, +and you have fixed an error, the commit or merge request should look like this: + +`mail-client/freelook-bin: fix QA - EROOT missing slash` + +This system also applies on your metadata.xml and Manifest. \ No newline at end of file