Skip to content

Commit dbda589

Browse files
πŸ“ Branch naming conventions (#23)
* πŸ“ Created branch naming conventions * πŸ“ Updated branch documentation * πŸ“ Fixed indentation in contributing TOC --------- Co-authored-by: BattleCh1cken <[email protected]>
1 parent eb68056 commit dbda589

File tree

1 file changed

+18
-7
lines changed

1 file changed

+18
-7
lines changed

β€Ž.github/CONTRIBUTING.mdβ€Ž

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,15 @@ All types of contributions are encouraged and valued. See the [Table of Contents
1717
## Table of Contents
1818

1919
- [I Have a Question](#i-have-a-question)
20-
- [I Want To Contribute](#i-want-to-contribute)
21-
- [Reporting Bugs](#reporting-bugs)
22-
- [Suggesting Enhancements](#suggesting-enhancements)
23-
- [Your First Code Contribution](#your-first-code-contribution)
24-
- [Improving The Documentation](#improving-the-documentation)
20+
- [I Want To Contribute](#i-want-to-contribute)
21+
- [Reporting Bugs](#reporting-bugs)
22+
- [Suggesting Enhancements](#suggesting-enhancements)
23+
- [Your First Code Contribution](#your-first-code-contribution)
24+
- [Improving The Documentation](#improving-the-documentation)
2525
- [Style Guides](#style-guides)
26-
- [Typst Code](#typst-code)
27-
- [Commit Messages](#commit-messages)
26+
- [Typst Code](#typst-code)
27+
- [Commit Messages](#commit-messages)
28+
- [Branches](#branches)
2829

2930
## I Have a Question
3031

@@ -176,6 +177,16 @@ Commit messages should be short and descriptive. This project follows the [Gitmo
176177

177178
Use the unicode version of the emojis wherever possible. This means you should write πŸ”₯ instead of :fire:.
178179

180+
### Branches
181+
182+
Branches must have labels depending on what the branch changes to the project.
183+
184+
- Fix: improves a pre-existing feature
185+
- Feature: adds a new feature
186+
- Theme: adds a new theme
187+
188+
A complete branch name would be **theme/your-theme-name** or **feature/theme-cover**.
189+
179190
## Attribution
180191

181192
This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!

0 commit comments

Comments
Β (0)