Skip to content

πŸ” Commit Structure

Daniel B edited this page Nov 29, 2023 · 1 revision

This file defines the structure of commits for Semantyk projects.

Types

  • 🧹 Chore: Changes that don't affect the user-facing functionality of the project.
  • πŸ““ Docs: Changes to the documentation.
  • ✨ Feature Changes to the codebase that add new functionality.
  • πŸ› Fix: Changes to the codebase that fix bugs.
  • πŸ”§ Refactor: Changes to the structure of the codebase.
  • πŸš€ Performance: Changes to the codebase that improve performance.
  • πŸ§ͺ Test: Changes to the test suite.

Structure

  • Type: One of the commit types mentioned above.
  • Subject: A brief (50 characters or fewer) summary of the change.
  • Body: A more detailed explanation of the change. Explain what and why, not how.
  • Footer: Additional notes, issue tracker references, etc.

Template

<type>: <subject>
β€’ <body>

<footer>

Example

πŸ› Fix: Fix bug in the login page

- Fix bug in the login page that prevented users from logging in.

Closes #123
Clone this wiki locally