Skip to content
This repository has been archived by the owner on Apr 29, 2024. It is now read-only.

Latest commit

 

History

History
35 lines (24 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

35 lines (24 loc) · 1.21 KB

Contributing

When contributing to this repository, please check Issues and Projects. Also, it's a good idea to drop a message on our Discord channel or start a discussion first to let others know what you're planning to work on.

Styleguides

Git Commit Messages

  • Use the present tense and imperative mood
  • Limit the first line to 72 characters

Code Style

To keep the source consistent and easy to merge, we are using ClangFormat to format code. You can find .clang-format config in the root.

Pull Request Process

To make the approval process easier and faster, your pull request should include the following (if applicable):

  • A link to issue or project card
  • Reasoning of changes
  • Summary of changes

There are also some tips:

  • If you are working on different features, split the job to branches
  • Prefer to rebase over merge when pulling changes from master
  • Avoid mixing tasks in a single Pull Request
  • Give understandable names for commits
  • Be sure that all your changes are clear to understand