Collaboration rules

Hillel Trip Planner App

Java Pro 10-10-2023

Definition of 'ready' (ToDo)

• Task / Story contains
  • Description
  • Acceptance criteria
  • Further relevant details
• Bug contains
  • Description
  • Desired behavior
  • Actual behavior
  • Steps to reproduce
  • Occurance (always, sporadic, ...)
  • Severity
  • Affected versions

Commit and branch requirements

Branches

• main branch contains production ready code
• feature/* subbranches contain code changes repesenting new features
• bugfix/* subbranches contain bug fixes
• subbranches of feature and bugfix must include the issue id and brief title

Example feature/100200_add-hotel-booking or bugfix/20101_fix-abandoned-booking

Commits

• Multiline commits are accepted First line of the commit should container the issue id, type (FEATURE or BUG) and title and must be followed by a line break
• next lines should contain bullet points briefly describing the changes

Example

480100: [FEATURE] Add database connection

- database driver added
- added queries code

Pull requests

• Pull request must include one required reviewer @ownerofglory
• Pull request can include one or more optional reviewers
• Pipeline should be executed successfully

Definition of 'done' (DoD)

• Code Quality and Functionality:

  • Code changes are thoroughly reviewed and don't introduce new bugs.
  • The project compiles and builds without errors.
  • New features or changes align with the project's design and architecture.
  • All functionalities work as expected and fulfill the requirements.

• Testing:

  • Code changes are fully covered by unit tests. All unit tests pass (green status).

• Documentation:

  • Relevant documentation is updated to reflect changes in the codebase.

---