Skip to content

Latest commit

 

History

History
executable file
·
81 lines (48 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
81 lines (48 loc) · 2.76 KB
Raw

Contributing

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

Types of Contributions

Report Bugs

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

You can never have enough documentation! Feel free to contribute to any part of the documentation, including official docs, docstrings, or web content like blog posts, articles, etc.

Submit Feedback

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

General Python Practices

When contributing to this project, please adhere to the following Python practices:

  • Follow PEP 8 for style guide recommendations.
  • Ensure your code is clean, efficient, and well-documented. All methods must include documentation that follows the Google Python Style Guide, clearly describing the method's purpose, its arguments, return values, and any exceptions raised.

Get Started!

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

  1. Download a copy of tsdf locally.

  2. Install tsdf using poetry:

    $ poetry install

  3. Create a branch for local development:

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

  4. Make your changes and ensure they meet the code formatting and documentation standards.

  5. Check that your changes pass all tests.

  6. Commit your changes and push to the branch:

    $ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through GitHub.

Pull Request Guidelines

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

  1. The pull request should include tests that prove any new functionality works as expected.
  2. If the pull request adds functionality, the documentation should be updated accordingly.
  3. The pull request should work for Python's currently supported versions and major operating systems.

Code of Conduct

Please note that the tsdf project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.