CONTRIBUTING.md

Contributing to hausse

Welcome here! hausse is a little first project, originally intended for the creation of static web sites, but which seeks to be as versatile as possible. Feel free to contribute with new features and use cases!

• Report bugs and request new features
• Get started with the source code
  • Begin from the start
  • Workspace setup
  • Tests
  • Conventions
  • Pull request checklist
• Fix bugs or implement features
  • Good first issues
• Improve the documentation

Report bugs and request new features

If you encounter a bug or a missing feature, file an issue in the issue tracker.

For bugs, please include exhaustive informations about your operating system and specific used setup in your report, as well as steps to reproduce the bug.

Get started with the source code

hausse runs on Python 3.9. You can check your version by typing python -V in a console.

Begin from the start

If all of this is new to you, feel free to consult the language documentation. You will also need git to checkout the source code on your machine and pushing you contributions. Then, you can proceed and find good first issues to process!

Workspace setup

First clone the repository:

git clone https://github.com/andrenasturas/hausse.git

Then install the dependencies. It is recommended to do so inside a virtual environnement.

cd hausse
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

And then you are ready to code!

Tests

In hausse, testing is done with pytest library. You can run tests with this command:

python -m pytest

Conventions

Some conventions are enforced in this project:

• Source code must comply to PEP8 naming rules and black formatting rules.
• Commit messages should follow conventional commits specification. Gitmojis may be used as commits types.

Pull request checklist

Before launching your pull request, make sure to check these little conditions:

• All tests pass
• New code is backed by new relevant tests
• Documentation is updated accordingly
• Code conventions are followed at best

Fix bugs or implement features

Pick an open issue in the issue tracker, fork the repository, get started with a development workspace on your forked repository, commit your contribution and initiate a pull request on the issue.

Good first issues

You are a beginner looking for interesting first issues ? You can look for good-first-issues labelled issues. You can also propose changes improving code quality, for example by adding tests to improve test coverage.

Improve the documentation

• You found a spot of documentation a bit unclear?
• You would like to translate the guide?
• Some method does not have its proper docstring?
• You have an idea of a new sensible and simple use case example?

Your help is very welcome. There is no such thing as overdocumented! You can create pull requests for improving .rst files, which are sources files of the documentation. The localization is handled by Transifex, where you can create an account and provide translations.