docs(contributing): update PR title guidelines to enforce convention (#476)
Some checks are pending
CI / test (macos-latest, 3.10) (push) Waiting to run
CI / test (macos-latest, 3.11) (push) Waiting to run
CI / test (macos-latest, 3.12) (push) Waiting to run
CI / test (macos-latest, 3.13) (push) Waiting to run
CI / test (macos-latest, 3.8) (push) Waiting to run
CI / test (macos-latest, 3.9) (push) Waiting to run
CI / test (true, ubuntu-latest, 3.13) (push) Waiting to run
CI / test (ubuntu-latest, 3.10) (push) Waiting to run
CI / test (ubuntu-latest, 3.11) (push) Waiting to run
CI / test (ubuntu-latest, 3.12) (push) Waiting to run
CI / test (ubuntu-latest, 3.8) (push) Waiting to run
CI / test (ubuntu-latest, 3.9) (push) Waiting to run
CI / test (windows-latest, 3.10) (push) Waiting to run
CI / test (windows-latest, 3.11) (push) Waiting to run
CI / test (windows-latest, 3.12) (push) Waiting to run
CI / test (windows-latest, 3.13) (push) Waiting to run
CI / test (windows-latest, 3.8) (push) Waiting to run
CI / test (windows-latest, 3.9) (push) Waiting to run
CodeQL / Analyze (push) Waiting to run
Build & Push Container / ECR (push) Waiting to run
Build & Push Container / GHCR (push) Waiting to run
release-please / release (push) Waiting to run
OSSF Scorecard / Scorecard analysis (push) Waiting to run

This commit is contained in:
Mickael 2025-07-30 19:07:17 +02:00 committed by GitHub
parent 7886b5d84f
commit d1f8a80826
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -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).
---
@ -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.
---
@ -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):
@ -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.*