CONTRIBUTING.md

Contributing

Thanks for your interest. This document includes guides and steps how to setup the local environment and make pull requests.

Table of Contents

• Setup
• Pull requests

Setup

Installing the dependencies

1. Have python installed. We suggest using pyenv to manage python versions.

2. Create virtualenv.

   $ python -m venv venv

3. Activate virtualenv.

   $ source venv/bin/activate

4. Install pip-tools.

   $ python -m pip install pip-tools

5. Run pip-sync to download dependencies.

   $ pip-sync
   

Adding dependencies

1. Add the dependency in requirements.in.

   --- a/requirements.in
   +++ b/requirements.in
   @@ -1 +1,2 @@
   pre-commit
   +pytest

2. Run pip-compile, which adds it to your requirements.txt.

   $ pip-compile

3. Run pip-sync to install the missing dependencies.

   $ pip-sync

Pre-commit

This repository leverages pre-commit to run custom git hooks.

1. Install the git hooks

   $ pre-commit install
   

Each time that you make a commit, it will run all the git hooks specified in .pre-commit-config.yaml.

Pull requests

Each pull request requires a changelog entry. This can be generated by running:

$ make changelog

Commits

Please use the proper commit message format as elaborated by the AngularJS team.

All pull requests without proper commit message will be rejected.