Contributing to Gitingest

July 30, 2025 · View on GitHub

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.

How to Contribute (non-technical)

Create an Issue – found a bug or have a feature idea? Open an issue.
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 with anything you notice.

How to submit a Pull Request

Prerequisites: The project uses Python 3.9+ and pre-commit for development.

Fork the repository.

Clone your fork:

git clone https://github.com/coderamp-labs/gitingest.git
cd gitingest

Set up the dev environment:

python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev,server]"
pre-commit install

Create a branch for your changes:
```
git checkout -b your-branch
```
Make your changes (and add tests when relevant).
Stage the changes:
```
git add .
```
Run the backend test suite:
```
pytest
```
(Optional) Run pre-commit on all files to check hooks without committing:
```
pre-commit run --all-files
```
Run the local server to sanity-check:
```
python -m server
```
Open http://localhost:8000 to confirm everything works.
Commit (signed):
```
git commit -S -m "Your commit message"
```
If pre-commit complains, fix the problems and repeat 5 – 9.
Push your branch:
```
git push origin your-branch
```
Open a pull request on GitHub with a clear description.

Important: Pull request titles must follow the Conventional Commits specification. This helps with changelogs and automated releases.
Iterate on any review feedback—update your branch and repeat 6 – 11 as needed.

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