Add CONTRIBUTING.md

2026-10-15 19:31:18 +00:00
2 changed files with 12 additions and 17 deletions
@@ -0,0 +1,10 @@
 # Contributing to TwinTrack
 1. Every change starts as an issue. Pick or create one before you start.
 2. Branch from `main` as `issue-<number>-<short-name>`.
 3. Open a pull request with `Closes #<number>` in the description.
 4. The other team member reviews it, leaves at least one comment or question,
   and approves once it is addressed. You cannot approve your own pull request.
 5. After approval, merge. The issue closes automatically.
 6. `main` is protected: no direct pushes.
 7. Never commit passwords, tokens, private keys or personal data.
@@ -1,18 +1,3 @@
-# TwinTrack
+# twintrack
-A small team task tracker that Group 1 (SSW 590) uses as its startup product.
+TwinTrack: Group 1's startup product
 The same application is delivered by two CI/CD pipelines (GitHub Actions and
 Jenkins) so the tools can be compared on security, speed, and operations.
 ## Status
 Planning. See the issues for the current backlog.
 ## How we work
 1. Every change starts as an issue.
 2. Branch from `main` as `issue-<number>-<short-name>`.
 3. Open a pull request with `Closes #<number>` in the description.
 4. The other team member reviews and approves; then merge.
 ## Team
 - Brahmi Dalvi — infrastructure (Gitea, cloud, CI)
 - Sakshi Deshpande — product (application, tests, documentation)