{"id":19085301,"url":"https://github.com/brayandiazc/template-gitmessage","last_synced_at":"2025-04-30T09:41:07.859Z","repository":{"id":155502586,"uuid":"430501369","full_name":"brayandiazc/template-gitmessage","owner":"brayandiazc","description":"This Git message template is designed to help streamline and standardize commit messages across your projects.","archived":false,"fork":false,"pushed_at":"2024-07-18T16:36:51.000Z","size":20,"stargazers_count":10,"open_issues_count":0,"forks_count":8,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-07-19T10:48:29.579Z","etag":null,"topics":["git","markdown","readme"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/brayandiazc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-11-21T23:02:32.000Z","updated_at":"2024-07-18T16:36:54.000Z","dependencies_parsed_at":null,"dependency_job_id":"0e3d5092-5003-4c8d-b415-1207929809e7","html_url":"https://github.com/brayandiazc/template-gitmessage","commit_stats":null,"previous_names":["brayandiazc/template-gitmessage-es","brayandiazc/template-gitmessage"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brayandiazc%2Ftemplate-gitmessage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brayandiazc%2Ftemplate-gitmessage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brayandiazc%2Ftemplate-gitmessage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brayandiazc%2Ftemplate-gitmessage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/brayandiazc","download_url":"https://codeload.github.com/brayandiazc/template-gitmessage/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223779911,"owners_count":17201287,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["git","markdown","readme"],"created_at":"2024-11-09T02:55:35.979Z","updated_at":"2024-11-09T02:55:36.687Z","avatar_url":"https://github.com/brayandiazc.png","language":null,"readme":"# Git Message Template\n\nThis repository contains a Git message template designed to help standardize and streamline commit messages across your projects. Consistent and clear commit messages are essential for maintaining a readable and maintainable project history.\n\n## Description\n\nSome tips so that the content of our commits is precise, easy to write, easy to read, and easy to interpret.\n\n## Tips for Git Messages\n\n1. Separate the title from the description using a blank line.\n2. The title must not contain more than 50 characters.\n3. Capitalize the first word of the title.\n4. Do not end the title with a period.\n5. Use the imperative mood in the title line.\n6. The description must not contain more than 72 characters per line.\n7. Use the description to explain what and why versus how.\n\n### Recommended Title Types\n\n- **feat**: New feature\n- **fix**: Bug fix\n- **refactor**: Refactoring code\n- **style**: Formatting, missing semi-colons, etc.; no code change\n- **docs**: Changes to documentation\n- **test**: Adding or refactoring tests; no production code change\n- **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation\n- **perf**: Code change that improves performance\n- **ci**: Changes to our CI configuration files and scripts (e.g., GitHub Actions, CircleCI)\n- **build**: Changes that affect the build system or external dependencies (e.g., gulp, broccoli, npm)\n- **revert**: Reverts a previous commit\n- **wip**: Work In Progress; for intermediate commits to keep patches reasonably sized\n- **hack**: Temporary fix to make things move forward; please avoid it\n\n## Commit Structure\n\n### Title (Subject Line)\n\n- **Purpose**: Summarizes the changes concisely.\n- **Format**: `\u003ctype\u003e: \u003csubject\u003e`\n- **Example**:\n\n```markdown\nfeat: add user authentication\n```\n\n### Body (Detailed Description)\n\n- **Purpose**: Provides a more detailed explanation of the changes made and why they were made.\n- **Format**: Use the imperative mood (e.g., \"Add\", \"Fix\", \"Update\"). Wrap text at 72 characters. Separate paragraphs with a blank line.\n- **Example**:\n\n```markdown\nFix issue with user login process by updating\nthe authentication method. The previous method\nwas not compatible with the new security requirements.\n\nThis fix ensures that users can log in without errors\nand improves the overall security of the application.\n```\n\n### Footer (Optional)\n\n- **Purpose**: Includes any additional information, such as related issue numbers or references.\n- **Format**: Use keywords like `Closes`, `Fixes`, `Refs`, followed by the issue number.\n- **Example**:\n\n```markdown\nCloses #123\n```\n\n### Note\n\n- **Purpose**: Special instructions, testing steps, rake tasks, etc.\n- **Example**:\n\n```markdown\nNote:\nSpecial instructions, testing steps, rake, etc.\n```\n\n### Co-authored-by\n\n- **Purpose**: Include for all contributors at the end of the commit message.\n- **Format**: `Co-authored-by: name \u003cuser@users.noreply.github.com\u003e`\n- **Example**:\n\n```markdown\nCo-authored-by: John Doe \u003cjohn.doe@example.com\u003e\n```\n\n## Example Commit Message\n\n```markdown\nfeat: add user authentication\n\nAdd a new feature for user authentication using JWT. This feature allows\nusers to securely log in and receive a token for subsequent requests.\n\n- Implemented JWT-based authentication\n- Added middleware to protect routes\n- Updated user model to include authentication methods\n\nCloses #45\n\nNote:\n\n- Remember to update environment variables with JWT secret key.\n- Ensure database migrations are applied before testing.\n\nCo-authored-by: Jane Doe \u003cjane.doe@example.com\u003e\n```\n\n## How to Use the Template\n\n1. Clone the Repository: Clone this repository to your local machine.\n\n```bash\ngit clone git@github.com:brayandiazc/template-gitmessage.git\n```\n\n2. Navigate to the Root Directory: Change to the directory where you cloned the repository.\n\n```bash\ncd template-gitmessage\n```\n\n3. Copy the Template File: Copy the .gitmessage file to your root directory.\n\n```bash\ncp .gitmessage ~\n```\n\n4. Configure Git: Set the template as your default commit message template by running the following command:\n\n```bash\ngit config --global commit.template ~/.gitmessage\n```\n\n## Author\n\n- [Brayan Diaz C](https://github.com/brayandiazc)\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n---\n\n⌨️ with ❤️ by [Brayan Diaz C](https://github.com/brayandiazc) 😊\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrayandiazc%2Ftemplate-gitmessage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrayandiazc%2Ftemplate-gitmessage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrayandiazc%2Ftemplate-gitmessage/lists"}