mirror of
https://github.com/lowRISC/ibex.git
synced 2025-04-23 13:27:10 -04:00
19 lines
773 B
Markdown
19 lines
773 B
Markdown
## Git Considerations
|
|
|
|
- Create your branch to commit your changes and then create a Pull Request.
|
|
- Separate subject from body with a blank line.
|
|
- Limit the subject line to 50 characters.
|
|
- Capitalize the subject line.
|
|
- Do not end the subject line with a period.
|
|
- Use the imperative mood in the subject line.
|
|
- Use the present tense ("Add feature" not "Added feature").
|
|
- Wrap the body at 72 characters.
|
|
- Use the body to explain what and why vs. how.
|
|
|
|
For a detailed why and how please refer to one of the multiple [resources](https://chris.beams.io/posts/git-commit/) regarding git commit messages.
|
|
|
|
If you use `vi` for your commit message, consider to put the following snippet inside your `~/.vimrc`:
|
|
|
|
```
|
|
autocmd Filetype gitcommit setlocal spell textwidth=72
|
|
```
|