Skip to content

Commit d1f8a80

Browse files
authored
docs(contributing): update PR title guidelines to enforce convention (#476)
1 parent 7886b5d commit d1f8a80

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Contributing to Gitingest
22

3-
Thanks for your interest in contributing to **Gitingest** 🚀 Our goal is to keep the codebase friendly to first-time contributors.
3+
Thanks for your interest in contributing to **Gitingest** 🚀 Our goal is to keep the codebase friendly to first-time
4+
contributors.
45
If you ever get stuck, reach out on [Discord](https://discord.com/invite/zerRaGK9EC).
56

67
---
@@ -10,7 +11,8 @@ If you ever get stuck, reach out on [Discord](https://discord.com/invite/zerRaGK
1011
- **Create an Issue** – found a bug or have a feature idea?
1112
[Open an issue](https://github.com/coderamp-labs/gitingest/issues/new).
1213
- **Spread the Word** – tweet, blog, or tell a friend.
13-
- **Use Gitingest** – real-world usage gives the best feedback. File issues or ping us on [Discord](https://discord.com/invite/zerRaGK9EC) with anything you notice.
14+
- **Use Gitingest** – real-world usage gives the best feedback. File issues or ping us
15+
on [Discord](https://discord.com/invite/zerRaGK9EC) with anything you notice.
1416

1517
---
1618

@@ -68,7 +70,7 @@ If you ever get stuck, reach out on [Discord](https://discord.com/invite/zerRaGK
6870
python -m server
6971
```
7072

71-
Open [http://localhost:8000](http://localhost:8000) to confirm everything works.
73+
Open [http://localhost:8000](http://localhost:8000) to confirm everything works.
7274

7375
10. **Commit** (signed):
7476

@@ -86,6 +88,10 @@ If you ever get stuck, reach out on [Discord](https://discord.com/invite/zerRaGK
8688

8789
12. **Open a pull request** on GitHub with a clear description.
8890

91+
> **Important:** Pull request titles **must follow
92+
the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification**. This helps with
93+
changelogs and automated releases.
94+
8995
13. **Iterate** on any review feedback—update your branch and repeat **6 – 11** as needed.
9096

9197
*(Optional) Invite a maintainer to your branch for easier collaboration.*

0 commit comments

Comments
 (0)