Skip to content

Latest commit

 

History

History
128 lines (81 loc) · 3.56 KB

CONTRIBUTING.md

File metadata and controls

128 lines (81 loc) · 3.56 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

sidetable could always use more documentation, whether as part of the official sidetable 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.

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 sidetable for local development.

  1. Fork the sidetable repo on GitHub.

  2. Clone your fork locally::

     $ git clone git@github.com:your_name_here/sidetable.git

  3. Install development dependencies:

     $ cd sidetable/
 $ pipenv install --dev

  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::

     $ flake8 sidetable tests
 $ python setup.py test or py.test
 $ tox

    To just run test quickly you can run python tests/test_sidetable.py

  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 3.6 and higher. Check Travis test and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ cd /tests
$ py.test test_sidetable.py

Deploying

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

python setup.py sdist bdist_wheel
twine upload dist/* --verbose

Updating conda-forge

Process here

Go to feedstock here

  • Update /recipe/meta.yaml
  • Raw edit the file and save as a new branch
    • latest version
    • sha256: sha256sum sidetable-VER-.tar.gz
  • Background process will run to validate the pull request
  • Once all complete merge the request