Contribute

Any feedback or contribution to el0ps is welcome.

Bug report

Altough unit tests are in place, there might be some bugs. Please report any issues you encounter in the issue page. You can also suggest new features or improvements in this page.

Pull request

New contribution are made through the pull requests page. Please make sure that your code is PEP8 compliant and that you have added unit tests for your new features. You can proceed as explained below.

  1. Fork the repository on your GitHub account.

  2. Clone el0ps on your local machine using the command

git clone https://github.com/{YOUR_GITHUB_USERNAME}/El0ps

  1. Install the package locally and the development dependencies using the command

cd El0ps
pip install -e .[dev]

  1. Make a new branch for your feature using the command

git branch my_new_feature
git switch my_new_feature

  1. Make your changes and add unit tests for them.

  2. Open a pull request on el0ps repository.

You can build the documentation locally using the command

sphinx-build -M html doc/source/ doc/build/

from the root of the repository. The generated documentation will be in the doc/build/ directory.