Skip to content

Commit 924f7e2

Browse files
authored
Create CONTRIBUTING.md
1 parent d1f4881 commit 924f7e2

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

docs/CONTRIBUTING.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# :snowman: How to Contribute :snowman:
2+
3+
We are quite glad you made it here! We can only keep our project in good health thanks to contributors like you! There are some points
4+
we would like to highlight in terms of contributing to this repository.
5+
6+
## Bug Reports and New Features
7+
8+
- If you have any issue please report that using [Github Issues](https://github.com/coma123/Spring-Boot-Blog-REST-API/issues).
9+
Currently there's two kinds; Bug Reports and New Features.
10+
11+
- When writing a Bug Report or asking for a New Feature, please follow the template provided. Fill in the sections as much as you could so
12+
we have all teh information we need.
13+
14+
## Coding Contributions
15+
16+
- All coding contributions should be done through [pull requests](https://help.github.com/en/articles/creating-a-pull-request-from-a-fork). We do not respond to emails or coding posted via our Gitter channel. If you have any suggessions or want to contribute please open a [issue](https://github.com/coma123/Spring-Boot-Blog-REST-API/issues) first. This way we could discuss about the change and once finalized you could do a pull request.
17+
18+
- We don't have a comprehensive style guide for now, but we expect you code with due deligence with standard practices. Your code
19+
should pass the standard unit and integration tests (automatically run by Travis).
20+
21+
- Also please make sure your tests pass the [Sonar](https://sonarcloud.io/dashboard?id=coma123_Spring-Boot-Blog-REST-API) quality
22+
analysis. We strive to maintain A grade for all sections.
23+
24+
:snowman: This is all for now. Hope to update this document as we go along. If you have any suggestions please feel free to open
25+
an issue in our [issue tracker](https://github.com/coma123/Spring-Boot-Blog-REST-API/issues). :snowman:

0 commit comments

Comments
 (0)