Skip to content

Latest commit

 

History

History
118 lines (72 loc) · 3.22 KB

CONTRIBUTING.rst

File metadata and controls

118 lines (72 loc) · 3.22 KB
Raw

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Bug reports

When reporting a bug please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Documentation improvements

lipyphilic could always use more documentation, whether as part of the official lipyphilic docs, in docstrings, or even on the web in blog posts, articles, and such.

Feature requests and feedback

The best way to send feedback is to file an issue at https://github.com/p-j-smith/lipyphilic/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that code contributions are welcome :)

Development

To set up lipyphilic for local development:

  1. Create and activate an isolated development environment:

    conda create -n lipyphilic-dev -c conda-forge python=3.10 pip
conda activate lipyphilic-dev

  2. Fork lipyphilic (look for the "Fork" button).

  3. Clone your fork locally:

    git clone [email protected]:YOURGITHUBNAME/lipyphilic.git

  4. Install an editible version of lipyphilic along with its development dependencies:

    cd lipyphilic python -m pip install -e ".[dev]"

  1. Create a branch for local development:

    git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  2. When you're done making changes run all the checks and docs builder with tox one command:

    tox

  3. Commit your changes and push your branch to GitHub:

    git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

  4. Submit a pull request through the GitHub website.

Pull Request Guidelines

If you need some code review or feedback while you're developing the code just make the pull request.

For merging, you should:

  1. Include passing tests (run tox) [1].
  2. Update documentation when there's new API, functionality etc.
  3. Add a note to CHANGELOG.rst about the changes.
  4. Add yourself to AUTHORS.rst.
[1]

If you don't have all the necessary python versions available locally you can rely on Travis - it will run the tests for each change you add in the pull request.

It will be slower though ...

Tips

To run a subset of tests:

tox -e envname -- pytest -k test_myfeature

To run all the test environments in parallel:

tox -p auto

To check that the docs build:

tox -e docs

To run the tests (using python 3.10):

tox -e py310

To run tests and print test coverage in the terminal:

tox -e coverage

To check that the package builds correctly:

tox -e package