Skip to content

Commit 0e069e1

Browse files
committed
Create CONTRIBUTING.md
1 parent d11646a commit 0e069e1

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## How to contribute to NaWab
2+
3+
### <ins>Guidelines</ins>
4+
5+
If you want to contribute to the project, feel free to send a pull request.
6+
7+
- Commit messages should follow the following template:
8+
```
9+
component_name: one-line description
10+
<empty line>
11+
Extended multi-line description that includes
12+
the problem you are solving and how it is solved.
13+
```
14+
`component_name` is the concept/component whic this commit changes.
15+
16+
For eg:
17+
18+
- Telegram Bot: Add the stop command
19+
- Nawab: Inital Argparse integration
20+
- Twitter_bot: Add user account to blacklist
21+
22+
23+
Please pay attention to punctuation. In particular:
24+
- `one-line description` does *not* start with a Capital letter.
25+
- there is *no dot* at the end of `one-line description`.
26+
- `Extended multi-line description` is full English sentenses with Capital letters and dots.
27+
28+
Also note:
29+
- If you commit fixes an issue, please include `Fixes #NNN` line into commit message
30+
(where `NNN` is issue number). This will auto-close the issue. If you need to mention
31+
an issue without closing it, add `Update #NNN`.
32+
- Rebase your pull request onto the master branch before submitting.

0 commit comments

Comments
 (0)