Contributing to YAPSS

Thank you for considering contributing to YAPSS. Your help is vital for improving and maintaining this project.

How to Contribute

Reporting Bugs

If you find a bug, please report it by opening an issue.

  • Use a clear and descriptive title for the issue.

  • Describe the bug: Provide a clear and concise description of what the bug is.

  • Steps to reproduce: Explain the steps to reproduce the issue.

  • Expected behavior: Describe what you expected to happen.

  • Screenshots: If applicable, add screenshots to help explain the problem.

  • Environment: Include details about your setup (e.g., OS, Python version, dependencies).

Suggesting Enhancements

If you have an idea for an enhancement, please open an issue and describe:

  • Use a clear and descriptive title for the issue.

  • Describe the enhancement: Provide a clear and concise description of what you want to happen.

  • Explain why: Explain why this enhancement would be useful.

Code Contributions

  1. Fork the repository and create your branch from main, and clone the branch on your computer.

  2. Install dependencies:

    • Create and activate a virtual environment (e.g., venv).

    • Install the required dependencies by running:

      pip install ".[dev,doc]"

  3. Write tests:

    • Add tests for your new code in the tests/ directory (using pytest).

    • Ensure your tests cover edge cases and validate the functionality of your contribution.

  4. Run tests:

    • Verify all tests pass by running:

      tox

    • tox will automatically run pytest, mypy (for type-checking), and ruff (for linting and formatting).

    • Ensure no type errors or linting issues are present before submitting your PR.

  5. Submit a pull request (PR):

    • Create a PR with a clear title and description of your changes.

    • A project maintainer will review your PR and may request changes before merging.

    • Ensure your branch is up-to-date with main before submitting the PR.

Coding Guidelines

  • Follow the PEP 8 style guide.

  • Use black for code formatting.

  • Write clear and descriptive commit messages.

Licensing

By contributing to YAPSS, you agree that your contributions will be licensed under the same license as the project (MIT License).

Communication

If you need help or have any questions, feel free to reach out by opening an issue.

Thank you for contributing to YAPSS!