CONTRIBUTING.md 1.15 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# Contributing

Contributions are **welcome** and will be fully **credited**.

Please read and understand the contribution guide before creating an issue or pull request.

## Etiquette

It's the duty of the reviewers to ensure that all contributions to the project are of sufficient
quality to benefit the project. Many developers have different opinions. Respect the reviewers decision, and do not be upset or abusive if your contribution is rejected.

## Viability

When requesting or submitting changes, first consider whether it might be useful to others. Think about
whether or not your contribution is likely to be used by other users of the project.

## Procedure

Before submitting a merge request:

- Check the documentation to ensure that your contribution doesn't already exist.
- Check the merge requests to ensure that another person hasn't already submitted the contribution or fix.

## Requirements

If the project maintainer has any additional requirements, you will find them listed here.

- **Short but explicit** - Make sure to write explicit short texts. Longer texts tend to be difficult to read in an already quite long documentation.

**Happy contribution**!