Skip to content

Latest commit

 

History

History
74 lines (46 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

74 lines (46 loc) · 2.46 KB

Contributing

We welcome contributions of all kinds, and your help is greatly appreciated! Whether it's fixing bugs, adding new features, or improving documentation, your efforts make a difference, and you will always be credited for your work.

Types of Contributions

Report Bugs

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any relevant details about your local setup that may assist in troubleshooting.
  • Detailed steps to reproduce the bug, along with any error messages.

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

Documentation is essential, and there's always room for improvement! You can contribute to various types of documentation, such as:

  • Official documentation (e.g., README, contributing guide).
  • Docstrings in the code.
  • External resources, including blog posts, tutorials, and articles.

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

Get Started!

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

  1. Download a copy of classifierpromax locally.

  2. Install classifierpromax using poetry:

    $ poetry install

  3. Use git (or similar) to create a branch for local development and make your changes:

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

  4. Once you're done with your changes, ensure that they adhere to the project's code formatting requirements and pass all tests.

  5. Commit your changes and open a pull request.

Pull Request Guidelines

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

  1. The pull request should include additional tests if appropriate.
  2. If the pull request adds functionality, the docs should be updated.
  3. The pull request should work for all currently supported operating systems and versions of Python.

Code of Conduct

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