Skip to content

Commit a11ba04

Browse files
Restyled by prettier-markdown
1 parent 188c5b9 commit a11ba04

File tree

1 file changed

+49
-16
lines changed

1 file changed

+49
-16
lines changed

docs/CONTRIBUTING.md

Lines changed: 49 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,72 @@
1-
# Contributing to Phonebook
1+
# Contributing to Phonebook
22

33
## How can I contribute?
4+
45
### Reporting Bugs
6+
57
You can contribute by reporting bugs. For that there are some rules:
8+
69
- Before submitting please check that the same issue was not already submitted.
7-
- 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.
10+
- Use the
11+
[Bug-Report-Template](https://github.com/T-Systems-MMS/phonebook/issues/new?assignees=&labels=bug&template=bug_report.md&title=)
12+
and answer the questions.
813

914
### Suggesting new Features
10-
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:
11-
- Before submitting please check that the same feature request was not already submitted.
12-
- 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.
15+
16+
If you have new ideas or have something that you really need in Phonebook you
17+
can submit a new feature request. For that there are some rules:
18+
19+
- Before submitting please check that the same feature request was not already
20+
submitted.
21+
- Use the
22+
[Feature-Request-Template](https://github.com/T-Systems-MMS/phonebook/issues/new?assignees=&labels=feature&template=feature_request.md&title=)
23+
and answer the questions.
1324

1425
### Your First Code Contribution
15-
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).
16-
If you have questions about the issue or do not know where to start you can just ask under the issue.
26+
27+
Unsure where to begin contributing to Phonebook? You can start by looking for
28+
the
29+
["good-first-issue"-label](https://github.com/T-Systems-MMS/phonebook/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
30+
If you have questions about the issue or do not know where to start you can just
31+
ask under the issue.
1732

1833
### Open Pull Requests
19-
If you want to open a pull request please use our [template](will be added soon). Please also note the issue which get resolved and stuff the reviewers need to know before reviewing your code.
34+
35+
If you want to open a pull request please use our [template](will be added
36+
soon). Please also note the issue which get resolved and stuff the reviewers
37+
need to know before reviewing your code.
2038

2139
## What should I know before I get started?
22-
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.
40+
41+
Before you start contributing be sure that you have already taken a look at our
42+
[Documentation](https://t-systems-mms.github.io/phonebook/). There you can find
43+
all things you need to know before work with the project.
2344

2445
### Mandatory stuff
25-
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/).
46+
47+
To provide good code quality we are using prettier to format all files the same
48+
way. Just make sure that you are using the Plugin
49+
[Prettier](https://prettier.io/) in your IDE. You can find our settings
50+
[here](https://prettier.io/).
2651

2752
## Styleguides
53+
2854
### Git Commit Messages
29-
Because of we are using [semantic release](https://github.com/semantic-release/semantic-release) it is important that the git messages, especially the merge messages, follow the [Angular commit Message Convention](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines).
55+
56+
Because of we are using
57+
[semantic release](https://github.com/semantic-release/semantic-release) it is
58+
important that the git messages, especially the merge messages, follow the
59+
[Angular commit Message Convention](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines).
3060
The messages should have the following format: `type(scope): subject`
3161

32-
- *type* -> feat, fix, chore and docs\
33-
- *scope* -> The part of the program which will be affected \
34-
- *subject* -> Description of what has been changed\
62+
- _type_ -> feat, fix, chore and docs\
63+
- _scope_ -> The part of the program which will be affected \
64+
- _subject_ -> Description of what has been changed\
3565

3666
## Additional Notes
67+
3768
### Issue and Pull request labels
38-
qualified: You can find additional information of what you need to do to solve this issue.
39-
good-first-issue: This Label represents problems with a lower complexity and a good way to start into the project.
69+
70+
qualified: You can find additional information of what you need to do to solve
71+
this issue. good-first-issue: This Label represents problems with a lower
72+
complexity and a good way to start into the project.

0 commit comments

Comments
 (0)