Skip to content

Commit 7115c33

Browse files
authored
Merge pull request #1 from naveedious/docs/Readme
docs: add Contributing section to README
2 parents 1fc298f + b16425d commit 7115c33

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -231,3 +231,17 @@ The app header shows the current version (e.g. `v2.0.0`) next to the Episode Gua
231231
```bash
232232
docker build -t episodeguard .
233233
```
234+
235+
## Contributing
236+
237+
All changes go through a branch and pull request — nothing gets merged directly to `main`.
238+
239+
1. Create a branch off `main` with a short descriptive name:
240+
```bash
241+
git checkout -b fix/webhook-auth
242+
```
243+
2. Make your changes and commit them with a clear message.
244+
3. Push the branch and open a pull request against `main`.
245+
4. The PR description should explain what changed and why.
246+
247+
There's no formal review requirement for a solo project, but the branch/PR flow keeps the history clean and makes it easy to revert if something breaks.

0 commit comments

Comments
 (0)