-
Notifications
You must be signed in to change notification settings - Fork 8
Add CONTRIBUTING.md and instructions for agents #191
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
+85
−0
Merged
Changes from all commits
Commits
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,12 @@ | ||
| # AGENTS.md | ||
|
|
||
| This file provides guidance to agentic coding assistants like Claude Code (claude.ai/code) when | ||
| working with code in this repository. | ||
|
|
||
| ## Important: Propose API Changes Before Implementing | ||
|
|
||
| Before making or proposing changes to any public API, open a GitHub issue to describe the | ||
| proposal and gather feedback. | ||
| See [CONTRIBUTING.md](./CONTRIBUTING.md) for details. | ||
|
|
||
| Do not create pull requests for public API changes without a corresponding issue. |
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 @@ | ||
| @AGENTS.md |
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,72 @@ | ||
| # Contributing to connect-python | ||
|
|
||
| ## Before You Contribute | ||
|
|
||
| If you're planning to add or change a public API, please open an issue describing your | ||
| proposal before starting work. | ||
| This helps ensure alignment with the project's direction and makes the review process | ||
| smoother for everyone. | ||
|
|
||
| ## Developer Certificate of Origin | ||
|
|
||
| All commits must be signed off to affirm compliance with the | ||
| [Developer Certificate of Origin](https://developercertificate.org/). | ||
| Configure your git identity to match your GitHub account, then use the `-s` flag when | ||
| committing: | ||
|
|
||
| ```console | ||
| $ git commit -s -m "your commit message" | ||
| ``` | ||
|
|
||
| ## Setting Up Your Development Environment | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - Python 3.10 or later | ||
| - [uv](https://docs.astral.sh/uv/) for dependency management | ||
| - [just](https://just.systems/) for running tasks | ||
|
|
||
| ### Installation | ||
|
|
||
| 1. Fork and clone the repository: | ||
|
|
||
| ```console | ||
| $ gh repo fork connectrpc/connect-python --clone | ||
| $ cd connect-python | ||
| ``` | ||
|
|
||
| 2. Verify everything is working: | ||
|
|
||
| ```console | ||
| $ uv run just check | ||
| ``` | ||
|
|
||
| ## Development Workflow | ||
|
|
||
| We use `just` as our task runner. | ||
| Run `uv run just --list` to see all available commands. | ||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't want to be in the business of keeping a list of these commands in sync here as well. |
||
|
|
||
| ## Submitting a Pull Request | ||
|
|
||
| 1. Create a feature branch from an up-to-date `main`: | ||
|
|
||
| ```console | ||
| $ git checkout -b your-feature-branch | ||
| ``` | ||
|
|
||
| 2. Make your changes and ensure all checks pass: | ||
|
|
||
| ```console | ||
| $ uv run just check | ||
| ``` | ||
|
|
||
| 3. Commit with a sign-off and a clear message, then push to your fork and open a pull | ||
| request. | ||
|
|
||
| Pull requests are more likely to be accepted when they: | ||
|
|
||
| - Include tests for new functionality | ||
| - Maintain backward compatibility | ||
| - Have clear commit messages | ||
|
|
||
| We aim to respond to issues and pull requests within a few business days. | ||
Oops, something went wrong.
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.
I assume most people use / are aware of the GitHub
ghCLI; this simplifies these instructions, but of course we could also rewrite them to use rawgit.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.
Otherwise they're also likely familiar with using the raw git command anyways. I'm a fan of "soft tool recommendations" like this doc