🤝 Contributing¶
Thanks for your interest! Here's how to get involved.
Reporting a bug¶
- Check that it doesn't already exist in Issues
- Create an issue using the "Bug Report" template
- Describe the steps to reproduce
- Include screenshots if relevant
Suggesting a feature¶
- Create an issue using the "Feature Request" template
- Describe the motivation and use cases
- List acceptance criteria
Submitting code¶
1. Fork and clone¶
git clone https://github.com/YOUR_USERNAME/github-project-llm-management.git
cd github-project-llm-management
2. Create a branch¶
# Recommended method: create an issue with the "auto-branch" label
# Or manually:
git checkout -b feat/123-my-feature
3. Develop¶
- Follow the code style
- Add tests
- Document your changes
git commit -m "feat: add new feature
- Description of the change
- Impact
- Tests added"
4. Test¶
pip install -r requirements-dev.txt
pytest tests/ -v
./scripts/validate_setup.sh
5. Create the PR¶
git push origin feat/123-my-feature
gh pr create --title "My feature (#123)" --body "Closes #123"
Checklist before submitting¶
- [ ] Tests pass
- [ ] Documentation updated
- [ ] No secrets committed
- [ ] Clear commit messages
- [ ] Issue linked in the PR
Code of conduct¶
See CODE_OF_CONDUCT.md. By participating, you agree to this code.