This repository has been archived by the owner on Sep 24, 2022. It is now read-only.
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.
Added README template and template guide for review #248
base: dev
Are you sure you want to change the base?
Added README template and template guide for review #248
Changes from all commits
8e3fa80
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
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.
Question (non-blocking): For me, I wonder if "install" would be better? We could make it more flexible with a format like this too:
How to get/install/download {Project Name} to show that there's a few choices?
Edited to add: Actually, I see you have an install, configure, run section later. What is the difference between those sections and the "how to get" section in your mind?
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.
The install/configure/run was what was in Sachin's original template. I think they likely could be joined together, but I can see the value in breaking it down if a project has a large number of steps for each. Let's chat about this!
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.
suggestion: I'd rewrite to a full sentence for consistency.