Skip to content

LuisSanchez/guidelines

Repository files navigation

Guidelines

This repository contains short, practical guidance for writing Git commit messages and creating high-quality Pull Requests (PRs). The materials are intended for public use and can be adopted by any team or open-source project to improve commit history clarity and PR consistency.

What’s inside

  • comments_explanation_es.md: A quick guide (Spanish) to Git commit messages — recommended types, examples, and tips.
  • pull_request_template.md: A PR template to standardize the information included in pull request descriptions.

Why this repo

  • Improve readability of commit history with semantic and focused commit messages.
  • Make PR reviews faster by providing reviewers with consistent, complete information.
  • Encourage best practices (Clean Code principles, short summaries, imperative tense).

Quick usage

  • Use semantic commit messages, for example: fix(users): Se corrigió el error foobar or feat(forecast): Se agregó la característica foobar.
  • Keep the commit summary under 50 characters and use the imperative mood (e.g., feat: agrega autenticación).
  • When opening a PR, start from pull_request_template.md and fill in the requested fields; attach screenshots or gifs for visual changes.

Files to review

  • comments_explanation_es.md — commit message guide (Spanish). Keep link formatting and examples when copying into workflows.
  • pull_request_template.md — copy its contents into your PR description when creating pull requests on GitHub.

If you'd like, I can also:

  • Add an English version of the commit guide.
  • Add a README badge and a short contributing section.

This repository is public — feel free to share and adapt these guidelines.

About

Simple repo for guidelines on github commits

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published