Skip to content

Latest commit

 

History

History
32 lines (24 loc) · 1.09 KB

CONTRIBUTING.md

File metadata and controls

32 lines (24 loc) · 1.09 KB

How to contribute to NaWab

Guidelines

If you want to contribute to the project, feel free to send a pull request.

  • Commit messages should follow the following template:
component_name: one-line description
<empty line>
Extended multi-line description that includes
the problem you are solving and how it is solved.

component_name is the concept/component whic this commit changes.

For eg:

  • Telegram Bot: Add the stop command
  • Nawab: Inital Argparse integration
  • Twitter_bot: Add user account to blacklist

Please pay attention to punctuation. In particular:

  • one-line description does not start with a Capital letter.
  • there is no dot at the end of one-line description.
  • Extended multi-line description is full English sentenses with Capital letters and dots.

Also note:

  • If you commit fixes an issue, please include Fixes #NNN line into commit message (where NNN is issue number). This will auto-close the issue. If you need to mention an issue without closing it, add Update #NNN.
  • Rebase your pull request onto the master branch before submitting.