Skip to content

Commit 25b8781

Browse files
committed
docs: 📝 added CONTRIBUTING.md
1 parent 222b017 commit 25b8781

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

CONTRIBUTING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing to Typescript-Node-Sequelize-Boilerplate
2+
3+
4+
# Instructions
5+
## Create an isuue
6+
- First of all, open an issue in the repository,
7+
describing the contribution you would like to make, the bug you found or any
8+
other ideas you have.
9+
10+
11+
## Fixing issues
12+
- Fork the project in your account and create a branch with your fix:
13+
`feat/your-feature` or `fix/some-issue`.
14+
15+
- Commit your changes in that branch,
16+
17+
18+
## Creating a pull request
19+
20+
- Open a pull request, and reference the initial issue in the pull request
21+
message (e.g. *fixes #<your-issue-number>*). Write a good description and
22+
title, so everybody will know what is fixed/improved.
23+
24+
- If it makes sense, add screenshots, gifs etc., so it is easier to see what
25+
is going on.
26+
27+
## Review
28+
Before accepting your contributions, request will be reviewed. You may get feedback
29+
about what should be fixed in your modified code. If so, just keep committing
30+
in your branch and the pull request will be updated automatically.
31+
32+
## Final
33+
Finally, your contributions will be merged
34+
35+
Thanks!
36+
37+

0 commit comments

Comments
 (0)