Skip to content

CONTRIBUTION.md

Latest commit

 

History

History
74 lines (53 loc) · 2.88 KB

CONTRIBUTION.md

File metadata and controls

74 lines (53 loc) · 2.88 KB
Raw

Contribution guide

First of all, thank you for checking this out. I appreciate everyone's work and everyone's effort to make this package better.

Documentation

Code documentation

Every function and class must be properly documented. All parameters should be documented, as well as the return type.

In addition to this, you should always use type annotation and avoid Any types as much as possible.

User documentation

If a new exposed behaviour is being introduced, you should update the README.md accordingly. You must also update the examples folder accordingly, both for classic and SSR if relevant.

If a breaking change is introduced, it must be introduced in two steps:

  1. Deprecation
    In this step, you must ensure the app remain completely functional, and mark the usage as deprecated.
  2. Removal
    In this step, you must remove the previous implementation, and write a guide in the DEPRECATION_AND_MIGRATION_GUIDE.md

Changes documentation

Once you're done with your work, you must add an entry to the CHANGELOG.md, describing your changes. Please make sure to explain why, and what you did in your PR description.

Tests

Every new code must be thoroughly tested, both on the happy and unhappy path, if no test covers it already. The code coverage limit is set to 98%.

Versioning

This repository adheres to semantic versioning. It is vital to respect it, and to not introduce a breaking change without a major update. Every pull request must come with a bump of the version specified in the pyproject.toml, so a new version can properly be deployed.

Working together

When you start working from an issue, please take a moment to:

  1. Write a comment, explaining that you're on it
  2. Create a pull request immediately, mentioning that it's a WIP
  3. If you encounter difficulties, write comments on the pull request so that others can contribute with their ideas, and so that we can know you're still working on it

Through your work on the pull request, please make sure to have commits that make sense for anyone. The commits should consist of :

  1. Blocks of work that fit together
  2. Have a name that briefly explain what it is about.
    You do not have to follow conventional commits or any specific pattern, just make sure that when one looks at the PR, and reviews it commit by commit, it makes sense.

Tools

This project uses poetry to handle dependencies and local environment. This project uses poethepoet to define some useful tasks for the project. You can use them, after having activated your environment, through poe ${command_name} If you find yourself missing a command, feel free to add and document it.

Validation

Once you are satisfied with your work, and you took care of all points mentioned above, please mention me in a comment to let me know I should review the pull request.