Skip to content

Latest commit

 

History

History
73 lines (48 loc) · 3.54 KB

CONTRIBUTING.md

File metadata and controls

73 lines (48 loc) · 3.54 KB
Raw

Contribution Guidelines

Thank you so much for your interest in contributing!. All types of contributions are valuable. 📝

Please make sure to read the documentation before making your contribution! It will make it a lot easier for us maintainers to make the most of it and smooth out the experience for all involved. 💚

If you have a question about this project, how to use it, or just need clarification about something

  • Open an Issue here
  • Provide as much context as you can about what you're running into.
  • Provide project and platform versions (python, pip etc), depending on what seems relevant. If not, please be ready to provide that information if maintainers ask for it.

Request a Feature

If the project doesn't do something you need or want it to do:

  • Provide as much context as you can about what you're looking for.
  • If you want to contribute that feature yourself, please open a new draft PR here.

Code Formatting

Please make sure that your code follows the PEP8 standards and that you provide proper type hinting for the functions and parameters along with proper spacing. You can follow this guide on how to integrate black formatter with various IDE's and Editors.

For VSCode users, create a .vscode folder in the project directory and a settings.json file inside it. Inside the file add the following lines:

{
    "python.formatting.provider": "black",
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "ms-python.python"
}

You can also use black filename in the terminal to format each file separately.

Make sure to use pre-commit with pre-commit run --all-files before pushing your changes.

Contributing Code

Code contributions of just about any size are acceptable!

Setting up a development environment:

  1. Fork the repository and then clone it to your local computer.
  2. OPTIONAL BUT RECOMMENDED: Create a new virtual environment with virtualenv using python3 -m venv venv.
  3. Activate the virtual environment and install the project dependencies using pip3 install -r requirements-dev.txt.
  4. Congrats 🎉, you are now ready to contribute.

To contribute the code:

  1. Set up the development environment.
  2. Make any necessary changes to the source code.
  3. If possible, make sure to include comments describing what your code does.
  4. Write clear, concise commit message(s).
  5. Push changes to your forked repository and when you are ready to get your changes reviewed, create a new PR from your forked repository.
  6. If your PR fixes an open issue, add a line in your PR's description that says closes #123, where #123 is the issue number that you're fixing.
  7. Someone from the maintainers will review your PR and will take the further steps.

NOTE: To contribute to the Documentation, follow the same steps as above.

Adding New Features

Here are some few things to keep in mind before working on a new feature:

  • We really want this library to be lightweight so please don't add features with heavy dependencies.
  • Keep the features relevant to the library.
  • Before adding a new feature, open up an Issue to discuss it or ping any mods on discord.

Provide Support on Issues

Helping out other users with their questions is a really awesome way of contributing to any community. If you can help out someone please go ahead for it. 🙂