Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
23 lines (19 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

23 lines (19 loc) · 1.19 KB

Contributing

We welcome contributions to this project! Here are some guidelines to follow:

Making Changes

  1. Fork the repository on GitHub
  2. Clone your forked repository to your local machine
  3. Create a new branch from the main branch for your changes
  4. Make your changes and commit them with clear commit messages following conventional commit standards
  5. Push your changes to your forked repository
  6. Open a pull request against the main branch of the original repository

Pull Request Guidelines

  • Title your PR with a brief description of the changes
  • In the PR description, explain in more detail the changes made and why they were made
  • Reference any relevant issues in the PR description (e.g. "Closes #42")
  • PRs will only be accepted if they pass all checks and are approved by a maintainer

Merging Pull Requests

  • Pull requests can only be merged by project maintainers
  • Changes must not be merged directly into main without an approved pull request
  • All commits in the pull request must follow conventional commit standards

Thank you for contributing! 🙌