Expand contribution steps #44
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
Clarify why GitHub access token is needed, and add note about classic and fine-tuned personal access tokens.
|
Excellent contribution. Thank you very much. |
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 PR reorganizes and expands on the steps needed to contribute, making them clearer to understand with each step being under their own heading with a description of said step.
The reasoning for this PR is that while the current steps are understandable there are some issues present. For instance, there is no clarification for why the GitHub access token is needed, which token type to generate, and if it should have any scopes attached.
This PR remedies that by adding clarification for why the GitHub access token is needed, adds a note about classic and fine-tuned personal access tokens, and a note about the fact that the token doesn't need to have any particular scopes added to them to work.
In this PR we also fix the issue of duplicated
npm startsteps, and that the steps for running the application are under the dependencies heading.Any feedback for this change is appreciated and welcomed.
Screenshot of update