Quick guide on maintaining and contributing to cu-bytes.
- Don't remember how to file an issue on GitHub? Read the GitHub Docs on creating an issue.
- Search for any existing issues before opening a new one.
- Include your working environment in (OS, setup, application version).
- Describe expected vs. actual behavior.
- Add labels (e.g.,
bug,enhancement) and attach screenshots/logs if helpful.
- Don't remember how to make a PR on GitHub? Read the GitHub Docs on creating a pull request.
- Branch naming
git checkout -b feature/section-description- Prefix with your tracker ticket if applicable (e.g.,
feature/frontend-update-homepage).
- Commit messages (Conventional Commits)
feat: add new user authentication page
fix: correct model training data
chore: run pre-commit hooks on test cases
docs: update README with restaurant examples
- Open a PR
- Target
main. - Clearly describe what changed and why; link the issue/ticket.
- Include before/after screenshots for report changes.
- Request reviewers and add labels.
- We use Git tags to manage and release versions of
cu-bytes. Tags follow Semantic Versioning.
- Make sure
mainis up to date:
git checkout main
git pull origin main- Create a new version tag:
git tag -a v0.2.0 -m "Release v0.0.0"-acreates an annotated tag- Replace
v0.2.0with the next versions- MAJOR: Breaking changes
- MINOR New features (backwards compatible)
- PATCH: Bug foxes/small improvements
-
Push the tag to GitHub
git push origin v0.2.0
-
GitHub Actions will detect the tag and create a new release.
-
We follow Google’s Python Style Guide as a baseline for Python code. For TypeScript, we follow Google's TypeScript Style Guide.
-
Manual Pre-commit checks:
pre-commit run --all-files