What should I know before I get started?
This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code.
Please make sure you go through the issues and pull requests before reporting a bug. There could be a chance that someone might already have reported a bug. When you are creating a bug report, please include as many details as possible to help us reproduce the problem easily.
If you have any suggestions or feature requests, create an issue. Try to explain why the feature is important and how it helps.
If you think the docs for some features are missing or incomplete and you'd like to contribute, you're more than welcome to create a PR. You can also contribute for typo fixes or grammatical errors in the docs if you do find them.
If you want to contribute to develop a feature, fix bugs or write tests, setup your environment using following steps and make sure the code you submit follows our style guidelines:
Clone the forked repository in your local system.
$ git clone https://github.com/kabirbaidhya/boss.git$ ./t setup$ ./t test$ ./t testw$ ./t changelog$ ./t publish- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move file to..." not "Moves file to...")
Be Consistent. If you're writing/editing code, take a few minutes to look at the code around you and determine it's style. If the code use spaces around if clauses, you should too.
If the code you add to a file looks drastically different from the existing code around it, it throws readers out of their rhythm when they to read it.
We are following the code style conventions as described in PEP8, make sure you're following these conventions too.
When you write some code, make sure you have documented the code you've written. For more information on how to properly document your code using docstrings click here.
Example:
def do_something():
''' This does something. '''
pass
def do_something_else():
'''
This does something else.
And something else.
'''
pass