Skip to content

Commit f384a23

Browse files
committed
Add CONTRIBUTING.md
Signed-off-by: Jan-Otto Kröpke <mail@jkroepke.de>
1 parent cd9fb69 commit f384a23

1 file changed

Lines changed: 54 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Contributing
2+
3+
This project uses GitHub to manage reviews of pull requests.
4+
5+
- If you are a new contributor see: [Steps to Contribute](#steps-to-contribute)
6+
7+
- If you have a trivial fix or improvement, go ahead and create a pull request,
8+
addressing (with `@...`) a suitable maintainer of this repository in the
9+
description of the pull request.
10+
11+
- If you plan to do something more involved, first discuss your ideas as
12+
[GitHub issue](https://github.com/jkroepke/setup-stackit-cli/issues). This will avoid
13+
unnecessary work and surely give you and us a good deal of inspirations.
14+
15+
- Be sure to sign off on the [DCO](https://github.com/probot/dco#how-it-works).
16+
17+
## Steps to Contribute
18+
19+
Should you wish to work on an issue, please claim it first by commenting on the
20+
GitHub issue that you want to work on it. This is to prevent duplicated efforts
21+
from contributors on the same issue. For quickly compiling and testing your
22+
changes do:
23+
24+
```bash
25+
# For building.
26+
npm run package
27+
28+
# For testing.
29+
npm run all # Make sure all the tests pass before you commit and push :)
30+
```
31+
32+
## Pull Request Checklist
33+
34+
- Branch from the main branch and, if needed, rebase to the current main branch
35+
before submitting your pull request. If it doesn't merge cleanly with main you
36+
may be asked to rebase your changes.
37+
38+
- Commits should be as small as possible, while ensuring that each commit is
39+
correct independently (i.e., each commit should compile and pass tests).
40+
41+
- The PR title should be of the format: `prefix: what this PR does` (for
42+
example, `feat: Add support for thing` or `fix: fix typo`). Valid prefixes are
43+
`feat`, `fix`, `docs` and `chore`. The prefix should be followed by a colon
44+
and a space.
45+
46+
- If your patch is not getting reviewed or you need a specific person to review
47+
it, you can @-reply a reviewer asking for a review in the pull request or a
48+
comment.
49+
50+
- Add tests relevant to the fixed bug or new feature.
51+
52+
## Dependency management
53+
54+
This project uses npm to manage dependencies on external packages.

0 commit comments

Comments
 (0)