Skip to content

Latest commit

 

History

History
126 lines (82 loc) · 3.46 KB

CONTRIBUTING.rst

File metadata and controls

126 lines (82 loc) · 3.46 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 at https://github.com/smart-spectral-matching/ssm-client-python/issues.

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 repository issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Implement Features

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

Write Documentation

ssm-client could always use more documentation, whether as part of the official ssm-client 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 at https://github.com/smart-spectral-matching/ssm-client-python/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 contributions are welcome :)

Get Started!

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

  1. Fork the ssm_client repo on [GitHub](https://github.com).

  2. Clone your fork locally:

    $ git clone [email protected]:your_name_here/ssm_client.git
$ cd ssm_client/

  3. Install your local copy into a virtualenv. Assuming you have [pdm](https://pdm.fming.dev/latest/) installed, this is how you set up your fork for local development:

    $ pdm install
$ pdm shell or pdm run <cmd> for a single command

  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 flake8 and the tests, including testing other Python versions with tox:

    $ pdm run make lint
$ pdm run make test
$ pdm run make test-all

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch:

    $ 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 repository 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.6, 3.7 and 3.8, and for PyPy. Check GitLab CI and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ pytest tests.test_ssm_client

Deploying

A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:

$ bump2version patch # possible: major / minor / patch
$ git push
$ git push --tags