Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (27 loc) · 1.32 KB

CONTRIBUTING.md

File metadata and controls

43 lines (27 loc) · 1.32 KB
Raw

Contributing

Thank you for your interest in contributing. Please follow the guidelines below so we can collaborate smoothly.

Getting Started

  1. Fork the repository.
  2. Clone it locally and create a feature branch. (git checkout -b feature/amazing-thing)
  3. Commit your changes with meaningful commit messages.
  4. Push your branch and open a Pull Request.

Development

  • Describe how to run and test the project locally in this section.
  • Add links to your tech stack and style guide if you have them.

Releasing

Create new releases from the Releases tab on GitHub.

Versioning (Semantic Versioning recommended)

  • Major: Incompatible changes that require users to change their workflow.
  • Minor: New features that remain backward compatible.
  • Patch: Bug fixes and transparent changes.

Include a summary of changes and migration notes in release notes when relevant.

Contribution Guidelines

Code Style

  • Follow the styleguide.
  • Write clear, consistent commit messages (e.g. Conventional Commits).

Submitting a Pull Request

  1. Work in a feature branch from your fork.
  2. Describe the purpose and scope of your changes in the PR.
  3. Request review after CI passes.
  4. Update documentation or config if your changes require it.

Thank you for contributing.