2020-03-18 01:44:30 +01:00
|
|
|
# Contributing
|
|
|
|
|
|
|
|
|
|
## How to contribute
|
|
|
|
|
|
2020-03-18 02:14:44 +01:00
|
|
|
src_prepare-overlay is very open to contribution and encourages it.
|
|
|
|
|
There are several ways to contribute for this overlay:
|
|
|
|
|
|
2020-03-18 01:44:30 +01:00
|
|
|
#### Filing an issue
|
|
|
|
|
|
2020-03-18 02:14:44 +01:00
|
|
|
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).
|
|
|
|
|
|
2020-03-18 01:44:30 +01:00
|
|
|
#### Pulling Merge Requests
|
|
|
|
|
|
2020-03-18 02:14:44 +01:00
|
|
|
Those that want to help us easily maintain an ebuild without making us spend our time creating on it
|
|
|
|
|
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).
|
|
|
|
|
|
2020-03-18 01:44:30 +01:00
|
|
|
## Contributing guidelines
|
|
|
|
|
|
2020-03-18 03:01:23 +01:00
|
|
|
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.
|
|
|
|
|
|
2020-03-18 01:44:30 +01:00
|
|
|
#### Filing an issue
|
|
|
|
|
|
2020-03-18 03:01:23 +01:00
|
|
|
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.
|
|
|
|
|
|
2020-03-18 02:14:44 +01:00
|
|
|
#### Pulling Merge Requests
|
2020-03-18 03:01:23 +01:00
|
|
|
|
|
|
|
|
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.
|
