-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Codex support: Update README.md and define AGENTS.md #6059
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
f7b1ae4
Update README.md
patmmccann 17924b1
Create AGENTS.md
patmmccann f9aa4bb
Update AGENTS.md
patmmccann bbd4a6f
Update AGENTS.md
patmmccann febdf26
Update README.md
patmmccann d7814ec
Update README.md
patmmccann b81c441
Update AGENTS.md
patmmccann File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # Agent Guidelines | ||
|
|
||
| - Run `markdownlint` on any edited Markdown files using the repository configuration with `markdownlint --config .markdownlint.json README.md`. Replace `README.md` with each file you change. | ||
| - If lint errors occur, fix them before creating a pull request. | ||
| - Verify the site builds with `bundle exec jekyll build` when possible. | ||
| - Please name your branch to include codex or agent in the branch name | ||
| - If you cannot run markdownlint please warn your user to setup their environment using the instructions in README.md and document your failure in your pr description |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This great, thanks 🙏
Hopefully those agents can soon spin-up the devcontainer, which should make this unnecessary in the future