Skip to content

Latest commit

 

History

History
107 lines (72 loc) · 3.93 KB

CONTRIBUTING.md

File metadata and controls

107 lines (72 loc) · 3.93 KB

Contributing to Disability Max Ratings API

Thank you for your interest in contributing to the Disability Max Ratings API! Contributions help us ensure this project continues to serve its purpose effectively. Whether you're fixing bugs, proposing enhancements, or improving documentation, your help is greatly appreciated.

Table of Contents

  1. Getting Started
  2. How to Contribute
  3. Pull Request Guidelines
  4. Style Guides
  5. Resources

Getting Started

For detailed setup instructions, please refer to the README.md.

How to Contribute

Reporting Issues

If you encounter a bug or have a question, please open an issue with the following information:

  • A clear and descriptive title
  • Steps to reproduce the issue
  • Expected vs. actual behavior
  • Relevant logs or screenshots, if applicable
  • Environment details (e.g., OS, Python version, etc)

Feature Requests

We welcome suggestions for new features! When submitting a feature request, please include:

  • A description of the feature and its purpose
  • Why it’s useful and how it aligns with the project’s goals
  • Any implementation ideas, if you have them

Code Contributions

To contribute code:

  • Fork the repository, clone it locally, and create a new branch for your changes
  • Follow the setup instructions in the README.md
  • Make your changes, adhering to the Style Guides
  • Please ensure all tests pass and add new tests for any new functionality
  • Commit your changes with clear and descriptive messages
  • Push your changes and open a pull request for review
  • Please ensure all CI checks pass before requesting a review

Pull Request Guidelines

  • Ensure your PR description clearly explains:
    • The purpose of the change
    • Any related issues (link to the issue, if applicable)
    • How the changes were tested
  • Follow the project’s Style Guides
  • Include tests for new features or fixes
  • Keep PRs small
    • Focus on a single issue or feature
    • Avoid bundling unrelated changes; however, small "Boy Scout Rule" improvements are welcome
  • Be responsive to feedback during the review process

Style Guides

Python Style Guide

The project follows the PEP 8 style guide for Python code using the 'ruff' formatter with 'mypy' for type checking. Additionally, it uses 'bandit' for security checks.

If the pre-commit hooks are installed, they will automatically run ruff, mypy, and bandit checks before committing changes.

Git Commit Messages

  • Use the imperative mood (e.g., "Add feature X" instead of "Added feature X")
  • Keep the first line under 50 characters
  • Provide additional details in subsequent lines, if necessary

Resources

Thank you for contributing to the Disability Max Ratings API! Your efforts make a difference.

Contact

If you have any questions or need assistance with contributing, feel free to reach out by opening an issue in the repository or contacting the maintainers directly through the issue tracker.