dariofavaron / TaskFlowAI

Other
2 stars 0 forks source link

Define branch naming conventions and commit message guidelines #5

Closed dariofavaron closed 11 months ago

dariofavaron commented 11 months ago

Branch Naming Conventions:

  1. Use hyphens to separate words in branch names.
  2. Include the type of work in the branch name (e.g., feature, bugfix, hotfix, release).
  3. Include a brief description of the work done or issue resolved in the branch name.
  4. Optionally, include the issue or ticket number related to the work done in the branch name.

Example: feature-add-login-button or bugfix-123-fix-login-issue

Commit Message Guidelines:

  1. Write commit messages in the imperative mood, as if you are giving orders to the codebase to change its behavior.
  2. Start the commit message with a capital letter.
  3. Do not end the commit message with a period.
  4. Keep the commit message short and concise. If more detail is needed, add a blank line after the summary and then write a more detailed description.
  5. If the commit is related to an issue or ticket, include the issue or ticket number in the commit message.

Example: Add login button to homepage