Thank you for showing interes in contributing to Esmerald. There are many ways you can help and contribute to the project.
- Try Esmerald and report bugs and issues you find.
- Implement new features
- Help othes by reviewing pull requests
- Help writing documentation
- Use the discussions and actively participate on them.
- Become an contributor by helping Esmerald growing and spread the words across small, medium, large or any company size.
Reporting possible bugs and issues¶
It is natural that you might find something that Esmerald should support or even experience some sorte of unexpected behaviour that needs addressing.
The way we love doing things is very simple, contributions should start out with a discussion. The potential bugs shall be raised as "Potential Issue" in the discussions, the feature requests may be raised as "Ideas".
We can then decide if the discussion needs to be escalated into an "Issue" or not.
When reporting something you should always try to:
- Be as more descriptive as possible
- Provide as much evidence as you can, something like:
- OS platform
- Python version
- Installed dependencies
- Code snippets
Avoid putting examples extremely complex to understand and read. Simplify the examples as much as possible to make it clear to understand and get the required help.
To develop for Esmerald, create a fork of the Esmerald repository on GitHub.
After, clone your fork with the follow command replacing
YOUR-USERNAME with your GitHub username:
$ git clone https://github.com/YOUR-USERNAME/esmerald
Install the project dependencies¶
$ cd esmerald $ scripts/install
The project comes with a pre-commit hook configuration. To enable it, just run inside the clone:
Run the tests¶
To run the tests, use:
Because Esmerald uses pytest, any additional arguments will be passed. More info within the pytest documentation
For example, to run a single test_script:
$ scripts/test tests/test_apiviews.py
To run the linting, use:
Improving the documentation is quite easy and it is placed inside the
To start the docs, run:
To build a package locally, run:
It will install the requirements and create a local build in your virtual environment.
This section is for the maintainers of
Building the Esmerald for release¶
Before releasing a new package into production some considerations need to be taken into account.
- Like many projects, we follow the format from keepchangelog.
mainwith the release tag and list of the entries that are of interest to the users of the framework.
- What must go in the changelog? added, changed, removed or deprecated features and the bug fixes.
- What is should not go in the changelog? Documentation changes, tests or anything not specified in the point above.
- Make sure the order of the entries are sorted by importance.
- Keep it simple.
- The version should be in
__init__.pyof the main package.
- The version should be in
release PR is merged, create a new release
There will be a release of the version
0.2.3, this is what it should include.
- Release title:
- The description should be copied from the changelog.
Once the release is created, it should automatically upload the new version to PyPI. If something
does not work with PyPI the release can be done by running