KolibriOS/kolibrios
13
14
Fork 12
Code Issues 113 Pull Requests 16 Actions Projects 1 Releases Wiki Activity

improvement(docs): add branch style

Browse Source
This commit is contained in:
Gleb Zaharov
2025-03-15 17:17:35 +03:00
parent 59685a6ac5
commit 4ba363db16
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
CONTRIBUTING.md
View File

@@ -28,7 +28,7 @@ submitting a pull request consists of the following steps:
1. Find what you want to implement or improve 1. Find what you want to implement or improve
2. Make a fork of kolibrios (or other needed) repository 2. Make a fork of kolibrios (or other needed) repository
3. Create a branch with a name that matches your changes 3. Create a branch with a name that matches [the style](#branch-style)
4. Implement and test the changes 4. Implement and test the changes
5. Create commits according to the [accepted style](#commit-style) 5. Create commits according to the [accepted style](#commit-style)
6. Create and submit a pull request into `main` branch 6. Create and submit a pull request into `main` branch
@@ -38,6 +38,13 @@ When a pull request is submitted, at least two project participants must conduct
a code review, after which the proposed changes can be corrected (if it's a code review, after which the proposed changes can be corrected (if it's
necessary) and merged into the project. necessary) and merged into the project.
## Branch style
1. Your branch name should be as short as possible, but describes your changes
2. Words should be divided by minus sign (`-`)
3. Optionally, might starts with general [type](#types) of your future PR
with slash (`/`): `refactor/nasm-to-fasm`, `update/demos`, `fix/cp866 charset`
## Commit style ## Commit style
### Pattern ### Pattern