Skip to content

Add CONTRIBUTING guidelines for small, focused PRs #4

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

Open
MananGilhotra wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add CONTRIBUTING guidelines for small, focused PRs #4

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
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## Contributing

- Keep PRs small and focused (one script or feature per PR).
- Prefer argparse for new CLI features; validate user input.
- Preserve existing behavior unless you clearly improve UX.
- Include a short description and test steps in your PR body.
- Use informative commit messages and snake_case in Python.

### Local test checklist
- python3 -m py_compile path/to/script.py
- Run the script (interactive or with flags) and verify outputs.