Skip to content

Latest commit

 

History

History
118 lines (79 loc) · 3.67 KB

CONTRIBUTING.md

File metadata and controls

118 lines (79 loc) · 3.67 KB

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/rmusser01/tldw/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 GitHub issues for bugs. Anything tagged with "bug" or "help wanted" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "help wanted", "enhancement" or "Feature-Addition" is open to whoever wants to implement it.

Write Documentation

tldw could definitely use more documentation, whether as part of the official tldw 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/rmusser01/tldw/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 tldw for local development.

  1. Fork the tldw repo on GitHub.

  2. Clone your fork locally:

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

  3. Check out the dev branch, where development happens prior to being merged into main. Your changes should be based on the dev branch, and your PR should eventually be requested against my dev branch.

     $ git checkout dev

  4. Install your local copy into a virtualenv (venv in modern python). Some linux distributions will require you to install python-venv or python3-venv, other times it will already be bundled with python. There are many ways to skin a cat, but this is how I usually set up a fork for local development:

    $ python3 -m venv .venv # set up hidden virtualenv folder: .venv
$ source ./.venv/bin/actiate # activate virtualenv
$ which python
/Users/me/tldw/.venv/bin/python
$ python -m pip install requirements.txt

  5. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature # or use e.g. issue_13

    Now you can make your changes locally.

  6. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 App_Function_Libraries/<your_file>.py
$ pytest Tests/test_<your_test>.py
$ tox (WIP)

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

  8. Submit a pull request through the GitHub website against my dev branch.

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 Docs/FEATURES.md
  3. The pull request should work for all Python versions that this project tests against with tox. Tests are ran automatically using Github Actions.

Tips

To run a subset of tests: pytest Tests/test_your_test.py