Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (34 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

52 lines (34 loc) · 1.91 KB
Raw

Contributing Policy

Hey, thanks for your interest in contributing to Quark! We appreciate your help and taking your time to contribute.

Before you start, please first discuss the feature/bug you want to add with the owners and community at our Discord server. This will help us to understand your needs and provide you with the best possible solution.

We have a few guidelines to follow when contributing to this project:

Commit Convention

Before you create a Pull Request, please make sure your commit message follows the Conventional Commits specification.

Commit Message Format

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Type

Must be one of the following:

  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • docs: Documentation only changes
  • chore: Changes to build scripts, that do not affect the source code or tests
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)

Example:

feat: add new feature

Pull Request

  • The master branch is the source of truth and should always reflect the latest stable release.
  • When creating a pull request, please provide a clear and concise description of the changes made.
  • If your pull request fixes an open issue, please reference the issue in the pull request description.
  • If your pull request adds new features, please consider creating a PR on the website repository that describes new feature.
  • Once your pull request is merged, you will be automatically added as a contributor to the project.

Thank you for your contribution!