Reforms - altanborali16/SWE574-Group2 GitHub Wiki

Immediate Reforms

GOOD COMMIT

Commit Naming Convention:

  • Format: type/issueNumber# commit message here

Example:

  • If you're adding a user class with base properties for feature development, the commit would look like:

    git commit -m "12# add user class with base properties"

BRANCHES AND PULL REQUESTS

Branch Creation for Developers:

Naming Convention:

  • Format: feature/author-issueNumber-simple-explanation

Examples:

  • Correct: feature/efe-33-build-security-configuration
  • Wrong: dev-backend-deployment-merge
  • Correct: release/author-issueNumber-dev-backend-deployment-merge

Tutorial for Branch Creation:

  1. Clone the repository: 
    git clone https://github.com/altanborali16/SWE574-Group2.git
  2. Check the current branch: 
    git branch
    (You will see the default branch, main)
  3. Switch to dev-backend branch: 
    git checkout dev-backend
  4. Create a new feature branch: 
    git checkout -b feature/efe-33-build-security-configuration
  5. Confirm the current branch: 
    git status
  6. Develop your feature.
  7. Check the changeset and branch: 
    git status
  8. Stage all changes: 
    git add .
  9. Commit the changes according to the standard: 
    git commit -m "33# add security filter chain"
  10. Double-check before pushing: 
    git status
  11. Push the branch: 
    git push
  12. Final status check: 
    git status

Note: Efe will be responsible for merging feature branches into dev-backend dev-backend-release and main .

Note: Each member is free to create their own feature branches and commit on them as they like.

CODE REVIEWS ARE MANDATORY

  • Every piece of work must be tied to an issue (e.g., diagram, mockup, requirements, deployment, etc.).

BACKEND & DEVOPS

  • Complete must-have features from the previous term.
  • Design mockups for:
    • Badge mechanism
    • Recommendation mechanism

FRONTEND

  • Complete must-have features from the previous term.

DESIGN

  • UI/UX Design for:
    • Badge mechanism
    • Recommendation mechanism

GitHub Maintenance & Documentation

  • All issues will be created with the approval of the leader (trial for this will end at 4th of NOV)
  • Issue modification and labelling is free to change for members.
  • Milestones will be created/modified with the approval of the leader.