Docs: Added README and contributing guide #124
@@ -43,18 +43,29 @@ Commit message body, if needed
|
||||
```
|
||||
|
||||
mxlgv marked this conversation as resolved
Outdated
|
||||
- Commit message header and body should reflect changes made in commit
|
||||
- Commit message header should start with a capital letter
|
||||
- Commit message body should be separated from the header by one empty line
|
||||
|
||||
### Length
|
||||
|
||||
Maximum number of characters in a commit header is **72** (standard for **Git**). Also, **72** is the maximum length of a line in a commit body.
|
||||
|
||||
## Merge commits
|
||||
### Multiple authors
|
||||
|
||||
If you are making a commit together with another developer, you need to add:
|
||||
|
||||
```
|
||||
Co-authored-by: ANOTHER-NAME <ANOTHER-NAME@EXAMPLE.COM>
|
||||
```
|
||||
mxlgv marked this conversation as resolved
Outdated
dunkaist
commented
Why not 50 and 72 like in Linux? Why not 50 and 72 like in Linux?
mxlgv
commented
I thought about it but I didn't find any advantages. Rather, we limit ourselves. I thought about it but I didn't find any advantages. Rather, we limit ourselves.
|
||||
|
||||
to the end commit message body on a new line.
|
||||
|
||||
### Merge commits
|
||||
|
||||
> [!WARNING]
|
||||
> Merge commits are **prohibited** in the project
|
||||
|
||||
Use **rebase** to keep your branch up to date.
|
||||
|
||||
## Conclusion
|
||||
|
||||
We hope this small instructions will help you to get familiar with KolibriOS contribution rules and inspire you to participate in the work of this project.
|
||||
Burer marked this conversation as resolved
Outdated
dunkaist
commented
instruction
familiar with (one space)
participate in the life of our project? > instructions
instruction
> familiar with
familiar with (one space)
> participate in the work of this project
participate in the life of our project?
|
||||
|
Reference in New Issue
Block a user
Text seems like too formal
For example, instead of this, you can simply write smth like
Commit message should look like
etc
Fixed