Contributing

Setup the environment

1. Download and install latest version of git.
2. Clone the repository locally

   $ git clone https://github.com/Diaga/connectu-backend.git
   $ cd connectu-backend

3. Create a virtualenv.

   $ python3 -m venv venv
   $ . venv/bin/activate

   On Windows, activating is different.

   $ venv/Scripts/activate

4. Install python dependencies

   $ pip install -r requirements.txt

5. Install the pre-commit hooks.

   $ pre-commit install

We Use GitHub Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use GitHub Flow). We actively welcome your pull requests:

1. Create your branch from master.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes.
5. Make sure your code lints.
6. Create that pull request!

Commit Message and Pull Request Title

Commit message and pull request title should follow Conventional Commits.

An easy way to achieve that is to install commitizen and run git cz when committing.