florent/pages
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
b67d2a19d8
pages/.github/GIT_WORKFLOW.md
George b67d2a19d8
Making Gemini and Claude configuration files point to AGENTS.md (#3494) 
This pull request updates project documentation to clarify and
standardize the development workflow, Git practices, and troubleshooting
resources. The main changes include adding a dedicated Git workflow
guide and reorganizing the `AGENTS.md` file for better clarity and
usability.

**Documentation and Workflow Improvements:**

* Added a new `.github/GIT_WORKFLOW.md` file detailing commit message
conventions, types, and best practices for staging and ignoring files.
* Reorganized and clarified the pre-commit checklist and local
development instructions in `AGENTS.md`, emphasizing Docker usage and
proper code formatting.
* Updated the section on configuration and troubleshooting in
`AGENTS.md` to better direct users to relevant resources and removed
redundant or outdated instructions.
[[1]](diffhunk://#diff-a54ff182c7e8acf56acfd6e4b9c3ff41e2c41a31c9b211b2deb9df75d9a478f9L57-R58)
[[2]](diffhunk://#diff-a54ff182c7e8acf56acfd6e4b9c3ff41e2c41a31c9b211b2deb9df75d9a478f9L100-R74)

**Configuration and Context Updates:**

* Added a `.gemini/settings.json` file to define context files for
Gemini agent operations, ensuring relevant documentation is available
for automation tools.
* Created `CLAUDE.md` file pointing to `AGENTS.md`.

---------

Signed-off-by: George Araújo <george.gcac@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-01-31 19:52:26 -03:00

1.4 KiB
Raw Blame History

Git Workflow

This document outlines the conventions for using Git and writing commit messages in this project.

Commit Message Format

All commit messages should follow this format:

<type>: <subject>

<body (optional)>

Types:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, etc.)
  • config: Changes to configuration files
  • chore: Changes to the build process or auxiliary tools and libraries

Examples:

feat: Add dark mode toggle button to header
fix: Correct baseurl in project site configuration
docs: Update INSTALL.md with Docker troubleshooting
style: Format all Liquid templates with Prettier
config: Enable blog section in _config.yml
chore: Update Jekyll dependencies with bundle update --all

Staging Changes

Always git add files explicitly. Do not stage everything with git add . unless you are certain of what's being committed. Check git status first to review your changes.

What NOT to Commit

Always obey the project's .gitignore file. It prevents the accidental commit of:

  • Build outputs (_site/, .jekyll-cache/)
  • Dependencies (node_modules/, vendor/)
  • OS-specific files (.DS_store)
  • Editor temporary files (.idea/, .swp, .swo)
  • Secrets and API keys (never commit credentials)