Clarify contribution for main-distribution packages
#3991
Merged
Conversation
This file contains 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
shhyou
added
the
documentation
mflatt
requested changes
Sep 17, 2021
| To start working on a package @nonterm{pkg-name}, it's usually best to | ||
| go to the root directory of your Racket repository checkout and run | ||
| To start working on a package @nonterm{pkg-name} from a Racket release | ||
| or snapshot, you first need to edit the package's catalog |
There was a problem hiding this comment.
"edit the package's catalog" is not quite right here. This should be something like "adjust the package installation to use the source specified by the main package catalog".
There was a problem hiding this comment.
Ah thanks, that's a better description of what's happening. 😄 I have updated this to match your wording.
This extends the contribution guide for `main-distribution` packages to describe two separate workflows 1. Release / snapshot 2. In-place build each of which needs slightly different commands.
jryans
force-pushed
the
snapshot-contribution-guide
branch
from
f5b9468
to
d84ab9e
Compare
|
@mflatt Thanks for taking a look, review comment addressed. 🙂 Someone will need to re-approve the workflows if a fresh CI pass is desired before merging. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This extends the contribution guide for
main-distributionpackages to describe two separate workflowseach of which needs slightly different commands.