Something
List main objectives, problems you aim to solve.
- Bill Processing (Admin Section)
- Bam
- SSO For Signing into App
- Language: python, sql, javascript, html, css
- Framework: react
- Database: aws
- etc...
Summary for developers with links to setup, build, test instructions in wiki or docs.
- Click "Use this template" on GitHub to create your private repository.
- Clone your repo locally.
- Fill in the metadata table above.
- Create an initial branch (e.g.,
setup
), never commit directly tomain
(unless instructed). - Open an Issue for each lab / feature before starting work.
- Use Pull Requests to merge changes (each PR should reference at least one Issue).
Include: what constitutes passing (e.g., all tests green, coverage threshold).
- Use semantic commit messages (see
CONTRIBUTING.md
for full details). - Open an Issue for every distinct unit of work (lab task, feature, bug, refactor, research).
- Create branches from
main
named after the Issue:<type>/short-kebab
(e.g.,feat/scheduler-phase1
). - Commit changes incrementally with semantic commit messages.
- Open a Pull Request early (draft) and link the Issue.
- Request peer review (if required) before merging.
- Squash merge or rebase to keep
main
linear (unless told otherwise).