Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 Branch naming conventions #23

Merged
merged 3 commits into from
Feb 20, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 18 additions & 7 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,15 @@ All types of contributions are encouraged and valued. See the [Table of Contents
## Table of Contents

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

## I Have a Question

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

Use the unicode version of the emojis wherever possible. This means you should write 🔥 instead of :fire:.

### Branches

Branches must have labels depending on what the branch changes to the project.

- Fix: improves a pre-existing feature
- Feature: adds a new feature
- Theme: adds a new theme

A complete branch name would be **theme/your-theme-name** or **feature/theme-cover**.

## Attribution

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