Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

44 lines (30 loc) · 1.83 KB
Raw

Contributing to conventional-commits-check

Thank you for your interest in contributing to conventional-commits-check. Here are some guidelines and instructions to follow when contributing.

Getting Started

  1. Fork the repository.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your changes.
  4. Make changes and commit them.
  5. Push the changes to your fork.
  6. Create a pull request to the main branch of the original repository.

Development Environment

  1. Install Python 3.x on your local machine.
  2. Create a virtual environment.
  3. Activate the virtual environment.
  4. Install the required packages by running pip install -r requirements.txt.
  5. Run tests using pytest.

Contributing Guidelines

Please ensure that your pull request adheres to the following guidelines:

  • Follow the Conventional Commits specification for commit messages.
  • Use the provided Flake8 configuration and ensure that your code passes all lint checks.
  • Write clear and concise documentation for any new features or changes.
  • Make sure that your changes do not introduce new issues or break existing functionality.

Reporting Issues

If you encounter any issues while using conventional-commits-check, please open a GitHub issue and include the following information:

  • A clear and descriptive title for the issue.
  • A detailed description of the issue, including steps to reproduce (if applicable).
  • The version of conventional-commits-check you are using.
  • Any relevant error messages or screenshots.

Code of Conduct

Please note that conventional-commits-check is governed by the Contributor Covenant Code of Conduct. By contributing to this project, you agree to abide by its terms.

Thank you for contributing to conventional-commits-check!