Created a CONTRIBUTING.pod for GitHub #350
Open
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.
Mentioned this idea in #349 -- thought I'd write it up in case you like it.
This file is a convenience for new contributors perusing the repository on github.com. Basically it just functions as a signpost to the resources that people should be accessing (like
docs/hacking.pod
).The presence of this file activates some GitHub features documented at Setting guidelines for repository contributors - GitHub Docs. This includes links on the "New pull request" form, and the https://github.com/bestpractical/rt/contribute route.
This functionality can also be activated by locating the file at
.github/CONTRIBUTING.pod
, but I think it's more convenient to have it visible at the repository root.I tested the GitHub rendering of this Pod markup at my fork.