src_prepare
/
src_prepare-overlay
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

CONTRIBUTING: fix some grammars; bold a sentence; apply example for Filing an issue; remove redundancy

This commit is contained in:
TheMainOne 2020-03-18 02:28:11 +00:00
parent 1426c1f601
commit 2f3b35df9d
1 changed files with 20 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
CONTRIBUTING.md
View File

@ -3,21 +3,21 @@
## How to contribute
src_prepare-overlay is very open to contribution and encourages it.
There are several ways to contribute for this overlay:
There are several ways to contribute to this overlay:
#### Filing 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)
so we can create the ebuild and maintain it for the community.
Before filing an issue, you will have to read the [contributing guidelines](#filing-an-issue-1).
Before filing an issue, you will have to read the [filing an issue guidelines](#filing-an-issue-1).
#### Pulling Merge Requests
Those that want to help us easily maintain an ebuild without making us spend our time creating on it
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)
so we can add the ebuild into our overlay and maintain it for you.
Before pulling merge requests, you will have to read the [contributing guidelines](#pulling-merge-requests-1).
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).
## Contributing guidelines
@ -26,16 +26,23 @@ 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:
When filing an issue you will have to provide:
- [CATEGORY]/[PACKAGE_NAME] (e.g. `www-client/icecat`)
- the description of the package
- the home page of the package
- 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:
```
EAPI=7
NAME=""
DESCRIPTION=""
HOMEPAGE=""
SRC_URI=""
LICENSE=""
DESCRIPTION=""
HOMEPAGE=""
SRC_URI=""
LICENSE=""
```
After this, you can safely file the issue, and we will take care of it.
@ -63,4 +70,4 @@ 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.
**This system also applies on your metadata.xml and Manifest.**