Skip to content

docs(contributing): update PR title guidelines to enforce convention #476

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.

Sign up for GitHub

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

Merged
MickaelCa merged 1 commit into from
Jul 30, 2025
Merged

docs(contributing): update PR title guidelines to enforce convention #476

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 9 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Contributing to Gitingest

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

---
Expand All @@ -10,7 +11,8 @@ If you ever get stuck, reach out on [Discord](https://discord.com/invite/zerRaGK
- **Create an Issue** – found a bug or have a feature idea?
[Open an issue](https://github.com/coderamp-labs/gitingest/issues/new).
- **Spread the Word** – tweet, blog, or tell a friend.
- **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.
- **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.

---

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

Open [http://localhost:8000](http://localhost:8000) to confirm everything works.
Open [http://localhost:8000](http://localhost:8000) to confirm everything works.

10. **Commit** (signed):

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

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

> **Important:** Pull request titles **must follow
the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification**. This helps with
changelogs and automated releases.

13. **Iterate** on any review feedback—update your branch and repeat **6 – 11** as needed.

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