First draft of CONTRIBUTING.md for plugins 💥 #66
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
* Makes very few assumptions about git experience * Helps setup upstream for tracking purposes * Helpful messaging around PR review * Suggestions on further involvement
majormoses
approved these changes
Oct 25, 2017
templates/CONTRIBUTING.md
Outdated
|
|
||
| ### 7) Create a Pull Request | ||
|
|
||
| Create a pull request by visiting https://github.com/<your-username>/<this-repo> and following the instructions at the top of the screen. |
There was a problem hiding this comment.
when previewing the markdown it looks like https://github.com// perhaps we should wrap it with a pair of backticks or choose a symbol such as $ rather than <>.
There was a problem hiding this comment.
Great point. I actually replaced it with the token substitution format used for https://github.com/mbbroberg/snap-pluginsync which I intend to use to distribute these to every plugin. I'll test it before running it, I promise 😆
Using the `<%= repo_name %>` format will allow for substituation when run with the pluginsync utility intended to distribute this file.
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.
Partially addresses #61
NOTE: Some formatting will be fixed once we decide on the toolchain that will be used to push this file across all repos.