Add pull request submission guidelines - #94
Open
Shafiqha wants to merge 1 commit into
Open
Conversation
cassidyjames
requested changes
Sep 2, 2026
cassidyjames
left a comment
cassidyjames
left a comment
Member
There was a problem hiding this comment.
Thanks for taking a pass at this! A couple of things that stand out right away:
-
It looks like the Markdown formatting is off. Please make sure headings are correctly notated, and paragraphs have an empty line between them; you can check some of the other prose-heavy pages like
meetings/guidelines.mdfor an example. -
This should probably be framed more as "Submitting Code Changes" or something instead of "Pull Requests". Pull requests are the mechanism we use on GitHub, but it might not be a familiar term to anyone not already using GitHub.
-
Make sure it's included in the right spot in
SUMMARY.md; I'd say it makes sense as the first item under Software Development Practices.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Closes #90
Adds software-development-practices/pull-requests.md, a companion doc
to CONTRIBUTING.md covering what makes a good PR: starting from an
issue, small diffs, draft PRs, writing your own PR description
(including how to attribute AI assistance rather than pasting its
output), and GitHub-native issue linking (fixes/related to).
Draws on cassidyjames's comment on #90 and the norms discussed in #62.
Kept intentionally lightweight per the issue's own scope.
Registered the new page in SUMMARY.md under Software Development
Practices, alongside the existing APIs/Agents/Security/Versioning
pages.