Skip to content

Commit 74d0171

Browse files
authored
added contribution guidelines (#1152)
1 parent c97604b commit 74d0171

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# How to contribute
2+
3+
We'd love to accept your patches and contributions to this project. There are
4+
just a few small guidelines you need to follow.
5+
6+
## Code reviews
7+
8+
All submissions require review. We use GitHub pull requests for this purpose. Consult
9+
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
10+
information on using pull requests.
11+
12+
## Pull request guidelines
13+
14+
- `Add a description`. Keep the person who is going to be reviewing the PR in mind. You are making their life easier when your description is formed in a way that brings them up to speed with minimum information.
15+
- `NO large PRs if possible`. Unless there is a specific technical reason that makes it impossible to split a large commit into multiple steps keep PRs small. It’s much easier to review smaller pull requests than go through hundreds of file changes in a single one. The larger the pull request, the higher is the chance of missing a bug or an edge case. Additionally, smaller pull requests get reviewed faster and are easier to merge since there tend to be less conflicts.
16+
- `NO PRs cross contexts allowed`. If you submit a PR where different contexts are being used it is hard for the reviewer to understand the changes and the he higher is the chance of missing a bug or an edge case.
17+
- `ONLY formatted/prettified code allowed`. If the code is not prettified ore formatted correctly any change from a colleague on the same file with a prettifier installed will change the whole file hiding the actual change.
18+
- `NO code chunks commented allowed`. If there are code chunks commented over the place makes it harder to follow the code. Description and links to documentation are very welcome. If no code is being used please remove it. You will find the code again in github history.
19+
- `NO sensitive data allowed in github.com`. Please private data, endpoints, user IDs, Passwords… actually everything which is PCI relevant can’t be committed.
20+
- `NO log of sensitive data`. It is not allowed to log sensitive data as user IDs, passwords, etc. since it is also no PCI compliant.

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -418,3 +418,9 @@ end
418418
## Mailer
419419
420420
From 19.08.2022 Elektra is using our own email service (Cronus) to send emails when users must be notified. This is the case for example when managing quota requests or creating new projects. Refer to [config/mailer.md](config/mailer.md) for details on how the mailer is setup.
421+
422+
## Contributing
423+
424+
Please read
425+
[CONTRIBUTING.md](https://github.com/sapcc/elektra/CONTRIBUTING.md)
426+
for details and the process for submitting pull requests to us.

0 commit comments

Comments
 (0)