Skip to content

Commit 4332779

Browse files
committed
add note about agent config files
1 parent a9f5bef commit 4332779

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

episodes/git-workflows.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,15 @@ Using remotes, fetching and merging upstream changes frequently, and running com
9595

9696
Now that you've chosen a workflow for your project, how do you communicate it? This is most often done with a CONTRIBUTING document. The CONTRIBUTING document describes the git workflow you are using, any conventions for branch naming that you have, and anything else a collaborator should know in order to contribute. It should be tailored to your project and team, and so it might also include how to run the tests for the project, requirements before creating Pull Requests, or perhaps detailed instructions for how follow the workflow if your team is less familiar with git. One of the goals of a CONTRIBUTING document is to lower the barrier to entry to contributing to a project and a good one will encourage collaboration.
9797

98+
:::::::::::::::::::::::::::::::::::::::::: callout
99+
100+
## AI Agent Configuration Files
101+
102+
If your group is using AI Coding agents you should also include an Agent configuration file in your repository, such as [AGENTS.md](https://agents.md/), [CLAUDE.md](addlink), or [copilot-instructions.md](addlink). Work with your team to tailor this file to your project. Include in the file that you are following the guidelines in the CONTRIBUTING document.
103+
104+
:::::::::::::::::::::::::::::::::::::::::::::::::::
105+
106+
98107
## Enforcing your Workflow
99108

100109
There are tools that you can use to make sure everyone follows the agreed upon workflow, which can make it easier to collaborate with others. First, you can add branch protections, which will enforce certain rules for certain branches. A common one is to not allow commits directly to the main branch, requiring changes to go through a Pull Request. There are many options for branch protection that you can read about on the [GitHub web page](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches). Similarly, you can limit who on the team is able to push or merge changes into a particular branch, or in the entire repository. It is also a good idea to have testing and review requirements, particularly for production branches. These requirements and branch protections should be documented in the CONTRIBUTING document as well.

0 commit comments

Comments
 (0)