docs: add instructions for building with local protos #388
Conversation
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
Explains how to test proto changes locally before publishing to Buf Registry. Addresses the workflow requested in issue authzed#137. Signed-off-by: ivanauth <ivan@authzed.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
Adds comprehensive instructions to
CONTRIBUTING.mdfor testing proto changes locally before publishing to the Buf Registry.Changes
magefiles/gen.go(#L26 instead of #L27)Context
Closes #137
Contributors requested clear documentation on how to build locally modified protos. The existing documentation mentioned "mage commands" but didn't explain the local development workflow.
Testing
Documentation-only change. Only
CONTRIBUTING.mdwas modified. No code or tests affected.