Contributing

To submit a pull request, please do the following:

Fork the repository by clicking on the 'Fork' button on the repository's page. This creates a copy of the code under your GitHub user account.

Clone your fork to your local disk, and add the base repository as a remote:

$ git clone git@github.com:<your Github handle>/DeCLUTR.git
$ cd DeCLUTR
$ git remote add upstream https://github.com/JohnGiorgi/DeCLUTR.git

Create a new branch to hold your development changes:
```
$ git checkout -b a-descriptive-name-for-my-changes
```
do not work on the master branch.
Set up a development environment by running the following command in a virtual environment:
```
$ pip install -e ".[dev]"
```
(If the repository was already installed in the virtual environment, remove it with pip uninstall before reinstalling it in editable mode with the -e flag.)
Develop the features on your branch.

This repository relies on black to format its source code consistently. After you make changes, format them with:
```
$ black declutr
```
This repository also uses flake8 to check for coding mistakes. To run the checks locally:
```
$ flake8 declutr
```
Once you're happy with your changes, add changed files using git add and make a commit with git commit to record your changes locally:
```
$ git add modified_file.py
$ git commit
```
Please write good commit messages.

It is a good idea to sync your copy of the code with the original repository regularly. This way you can quickly account for changes:
```
$ git fetch upstream
$ git rebase upstream/master
```
Push the changes to your account using:
```
$ git push -u origin a-descriptive-name-for-my-changes
```
Once you are satisfied, go to the webpage of your fork on GitHub. Click on 'Pull request' to send your changes to the project maintainers for review.

This is a work in progress. Inspiration for these guidelines were drawn from here and here.

Provide feedback