Skip to content

Commit 5165225

Browse files
authored
Create contributing guideline
1 parent fcb5125 commit 5165225

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

docs/CONTRIBUTING.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Contributing to Phonebook
2+
3+
## What should I know before I get started?
4+
Before you start contributing be sure that you have already taken a look at our [Documentation](https://t-systems-mms.github.io/phonebook/). There you can find all things you need to know before work with the project.
5+
6+
### Mandatory stuff
7+
To provide good code quality we are using prettier to format all files the same way. Just make sure that you are using the Plugin [Prettier](https://prettier.io/) in your IDE. You can find our settings [here](https://prettier.io/).
8+
9+
## How can I contribute?
10+
### Reporting Bugs
11+
You can contribute by reporting bugs. For that there are some rules:
12+
- Before submitting please check that the same issue was not already submitted.
13+
- Use the [Bug-Report-Template](https://github.com/T-Systems-MMS/phonebook/issues/new?assignees=&labels=bug&template=bug_report.md&title=) and answer the questions.
14+
15+
### Suggesting new Features
16+
If you have new ideas or have something that you really need in Phonebook you can submit a new feature request. For that there are some rules:
17+
- Before submitting please check that the same feature request was not already submitted.
18+
- Use the [Feature-Request-Template](https://github.com/T-Systems-MMS/phonebook/issues/new?assignees=&labels=feature&template=feature_request.md&title=) and answer the questions.
19+
20+
### Your First Code Contribution
21+
Unsure where to begin contributing to Phonebook? You can start by looking for the ["good-first-issue"-label](https://github.com/T-Systems-MMS/phonebook/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
22+
If you have questions about the issue or do not know where to start you can just ask under the issue.
23+
24+
### Open Pull Requests
25+
26+
### Reviewing a pull request
27+
28+
## Styleguides
29+
### Git Commit Messages
30+
31+
## Additional Notes
32+
### Issue and Pull request labels
33+
34+
### Explanation of label "prio"

0 commit comments

Comments
 (0)