Skip to content

Latest commit

 

History

History
82 lines (52 loc) · 3.15 KB

CONTRIBUTING.md

File metadata and controls

82 lines (52 loc) · 3.15 KB
Raw

Math CLI API Kit

GitHub License GitHub Issues GitHub Stars GitHub Forks

Contributing to Math CLI API Kit

Thank you for considering contributing to the Math CLI API Kit project! We appreciate your help in making this project better.

How to Contribute

To contribute to this project, please follow these guidelines:

  1. Fork the repository on GitHub.

  2. Clone the forked repository to your local machine.

    git clone https://github.com/yourusername/math-cli-api-kit.git

  3. Create a new branch for your feature or bug fix.

    git checkout -b feature/your-feature-name

  4. Make your changes and commit them with clear and concise commit messages.

    git commit -m "fix: Resolve issue with calculation"

    Commit Style Guide:

    • feat: For new features or enhancements.
    • fix: For bug fixes.
    • chore: For routine tasks, maintenance, or updates.
    • docs: For documentation-related changes.
    • style: For code style and formatting changes (whitespace, indentation).
    • test: For adding or modifying tests.
    • refactor: For code refactoring.
    • perf: For performance-related changes.

    Each commit message should be in the following format:

    <type>: Brief description

Additional details or explanations (if needed).

  5. Push your changes to your GitHub fork.

    git push origin feature/your-feature-name

  6. Create a pull request (PR) from your fork to the main repository on GitHub. Please provide a clear and detailed description of your changes in the PR.

  7. Your PR will be reviewed by the project maintainers. You may need to address feedback and make additional changes.

  8. Once your PR is approved, it will be merged into the main project.

Code Style

Please follow the PEP 8 code style guidelines for Python code contributions. Maintain coding standards and write clear and well-documented code.

Testing

Ensure that your code changes are thoroughly tested. If you are adding a new feature, provide appropriate test cases. If you are fixing a bug, include a test case that demonstrates the issue.

Reporting Issues

If you find a bug or have a suggestion for improvement, please open an issue on GitHub. Provide a clear and detailed description of the problem or enhancement request.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.

Thank you for your valuable contributions!