diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 50dc41d..f7f3540 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,31 +5,31 @@ src_prepare-overlay is very open to contribution and encourages it. There are several ways to contribute to this overlay: -#### Filing an issue +#### Submitting an issue Those that do not have good knowledge in writing ebuilds can -[file an issue](https://gitlab.com/src_prepare/src_prepare-overlay/-/issues) +[submit an issue](https://gitlab.com/src_prepare/src_prepare-overlay/-/issues) so we can create the ebuild and maintain it for the community. -Before filing an issue, you will have to read the [filing an issue guidelines](#filing-an-issue-1). +Before submitting an issue, you will have to read the [submitting an issue guidelines](#submitting-an-issue-1). -#### Pulling Merge Requests +#### Submitting Merge Requests Those that want to help us easily maintain an ebuild without making us spend our time creating the ebuild -can create the ebuild and pull a [merge request](https://gitlab.com/src_prepare/src_prepare-overlay/-/merge_requests) +can create the ebuild and submit a [merge request](https://gitlab.com/src_prepare/src_prepare-overlay/-/merge_requests) so we can accept and add the ebuild to our overlay and maintain it for you. -Before pulling a merge request, you will have to read the [pulling merge requests guidelines](#pulling-merge-requests-1). +Before submitting a merge request, you will have to read the [submitting merge requests guidelines](#submitting-merge-requests-1). ## 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. -**Before filing an issue or pulling a Merge Request, +**Before submitting an issue or submitting a Merge Request, first check if the package you are providing is not in [TODO.md](/TODO.md).** -#### Filing an issue +#### Submitting an issue -When filing an issue you will have to provide: +When submitting an issue you will have to provide: - [CATEGORY]/[PACKAGE_NAME] (e.g. `www-client/icecat`) - the description of the package @@ -37,7 +37,7 @@ When filing an issue you will have to provide: - OPTIONAL: the direct download link of the package - the license of the package (e.g. GPLv2) -by filling the skeleton of the ebuild in quotes: +by submitting the skeleton of the ebuild in quotes: ``` NAME="" @@ -48,16 +48,16 @@ SRC_URI="" LICENSE="" ``` -After this, you can safely file the issue, and we will take care of it. +After this, you can safely submit the issue, and we will take care of it. -#### Pulling Merge Requests +#### Submitting Merge Requests -When committing and/or pulling merge requests, you will have to respect our -Committing & Pulling Merge Requests System (CnPMRS) +When committing and/or submitting merge requests, you will have to respect our +Committing & Submitting Merge Requests System (CnPMRS) so we can easily identify the changes: - Provide us the Manifest file; -- Follow the committing & pulling merge request layout (below). +- Follow the committing & submitting merge request layout (below). Each commit will have to be based on this layout: