Contributing

Contributing

Get Started

1. Clone the repository

git clone https://github.com/alexym1/ComplAInce.git

1. Create a branch (from the master branch)

git checkout -b branch_name

1. Install package

make init
make install-prod

1. Making changes, and check your work:

make preco
make unittest
make test-docstrings

1. Commit

git add .
git commit -m "your message"

1. Push your branch

git push origin branch_name

Create a pull request

1. make preco

2. make unittest

3. make bump2version XXXXX (choices : major / minor / patch)

4. Update CHANGELOG.md with new entry

5. Generate the docs using make docs

6. Create a PR from to master

7. Review the PR and merge it.