Skip to content

Latest commit

 

History

History
118 lines (79 loc) · 3.1 KB

CONTRIBUTING.md

File metadata and controls

118 lines (79 loc) · 3.1 KB
Raw

Contributing

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

You can contribute in many ways.

Types of Contributions

Report Bugs

Report bugs here.

If you are 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.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write Documentation

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

Submit Feedback

The best way to send feedback is to file an issue here.

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 contributions are welcome :)

Getting Started

Ready to contribute? Here's how to set up xlavir for local development.

  1. Fork the xlavir repo on GitHub.

  2. Clone your fork locally

    git clone [email protected]:your_name_here/xlavir.git

  3. Install your local copy into a virtualenv.

    cd xlavir/ 
python -m venv venv 
source venv/bin/activate
pip install -e .[dev,test]

  4. Create a branch for local development

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

    Now you can make your changes locally.

  5. When you're done making changes, check that your changes pass ruff linting and the tests.

    ruff .
pytest

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

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 3.8, 3.9, 3.10 and 3.11. Check CI and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests

pytest tests.test_xlavir

Deploying

A reminder for the maintainers on how to deploy:

  1. Make sure all your changes are committed (including an entry in CHANGELOG.md).
  2. Make sure you have updated the version number in pyproject.toml
  3. GitHub Actions will then deploy to PyPI if tests pass.