Skip to content

Latest commit

 

History

History
114 lines (93 loc) · 4.38 KB

CONTRIBUTING.md

File metadata and controls

114 lines (93 loc) · 4.38 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/xplique.git.
  • Go to your freshly downloaded repo cd xplique
  • Create a virtual environment and install the necessary dependencies for development make prepare-dev && source xplique_dev_env/bin/activate.
  • You are ready to install the library pip install -e . or run the test suite make test.

Welcome to the team 🔥🚀 !

Setup without make ⚙️

  • Clone the repo git clone https://github.com/deel-ai/xplique.git.
  • Go to your freshly downloaded repo cd xplique
  • Install virtualenv with pip:
pip install virtualenv

Or with conda:

conda install -c conda-forge virtualenv
  • Create a new virtual environment
venv xplique_dev_env
  • Activate your new environment
. xplique_dev_env/bin/activate

Depending on your machine, this operation might be slightly different. For instance, on Windows you should probably do (with cmd.exe):

~/xplique> path\to\xplique_dev_env\bin\activate.bat

Or with Powershell:

PS ~/xplique> path\to\xplique_dev_env\bin\Activate.ps1

Anyway, if you suceed you should see your virtual environment name in front of any other command:

(xplique_dev_env) :~/xplique$
  • You can now install all necessary packages, with pip:
pip install -r requirements.txt
pip install -r requirements_dev.txt

Or with conda:

conda install --file requirements.txt
conda install --file requirements_dev.txt
  • You are ready to install the library:
pip install -e .
  • Or run the test suite:
tox

You are now ready to code and to be part of the team 🔥🚀 !

Tests ✅

A pretty fair question would be to know what is make test doing ? It is actually just a command which activate your virtual environment and launch the tox command. So basically, if you do not succeed to use make just activate your virtual env and do tox !

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 xplique 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.

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.
  • 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.

Documentation 📚

Xplique is a small library but documentation is often a huge time sink for users. That's why we greatly appreciate any time spent fixing typos or clarifying sections in the documentation. To setup a local live-server to update the documentation: make serve-doc or activate your virtual env and:

CUDA_VISIBLE_DEVICES=-1 mkdocs serve