Skip to content

Latest commit

 

History

History
56 lines (36 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

56 lines (36 loc) · 2.77 KB
Raw

Contributing

Thanks for taking the time to contribute!

From opening a bug report to creating a pull request: every contribution is appreciated and welcome. If you're planning to implement a new feature or change the api please create an issue first. This way we can ensure that your precious work is not in vain.

Setup with make

  • Clone the repo git clone https://github.com/deel-ai/deel-torchlip.git.

  • Go to your freshly downloaded repo cd deel-torchlip

  • Create a virtual environment and install the necessary dependencies for development:

    make prepare-dev && source torchlip_dev_env/bin/activate.

  • You are ready to install the library:

    pip install -e .

Welcome to the team !

Tests

To run test make test This command activate your virtual environment and launch the tox command.

tox on the otherhand will do the following:

  • run pytest on the tests folder with python 3.6, python 3.7 and python 3.8

Note: If you do not have those 3 interpreters the tests would be only performs with your current interpreter

  • run pylint on the deel-torchlip main files, also with python 3.6, python 3.7 and python 3.8

Note: It is possible that pylint throw false-positive errors. If the linting test failed please check first pylint output to point out the reasons.

Please, make sure you run all the tests at least once before opening a pull request.

A word toward Pylint for those that don't know it:

Pylint is a Python static code analysis tool which looks for programming errors, helps enforcing a coding standard, sniffs for code smells and offers simple refactoring suggestions.

Basically, it will check that your code follow a certain number of convention. Any Pull Request will go through a Github workflow ensuring that your code respect the Pylint conventions (most of them at least).

Submitting Changes

After getting some feedback, push to your fork and submit a pull request. We may suggest some changes or improvements or alternatives, but for small changes your pull request should be accepted quickly (see Governance policy).

Something that will increase the chance that your pull request is accepted:

  • Write tests and ensure that the existing ones pass.
  • If make test is succesful, you have fair chances to pass the CI workflows (linting and test)
  • Follow the existing coding style and run make check_all to check all files format.
  • Write a good commit message (we follow a lowercase convention).
  • For a major fix/feature make sure your PR has an issue and if it doesn't, please create one. This would help discussion with the community, and polishing ideas in case of a new feature.