Update README.md to make contribution steps easier to follow #42
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
Signed-off-by: Timothy Johnson <[email protected]>
zFernand0
reviewed
Nov 30, 2023
awharn
approved these changes
Dec 4, 2023
Signed-off-by: Timothy Johnson <[email protected]>
t1m0thyj
changed the title
t1m0thyj
requested review from
ATorrise,
traeok,
gejohnston,
KevinLoesch1 and
anaxceron
Signed-off-by: Timothy Johnson <[email protected]>
anaxceron
approved these changes
Jan 3, 2024
There was a problem hiding this comment.
Looks pretty good.
A few things that you should address:
- Decide whether to use "plug-in" or "plugin." I see both styles in this content, and there should only be one.
- Decide whether to capitalize Web Help or not. I see both styles in this content, and there should only be one.
- Decide whether to italicize your steps. There's no ital in Installing, but there is ital in the other sections. There should only be one formatting style consistently used through this ReadMe.
Signed-off-by: Timothy Johnson <[email protected]>
gejohnston
approved these changes
Jan 3, 2024
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.
Update the readme to add installation steps and summary of each step. Thanks @robertblum-psi for suggesting improvements to the readme.