Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Created a CONTRIBUTING.pod for GitHub #350

Open
wants to merge 2 commits into
base: stable
Choose a base branch
from

Conversation

NReilingh
Copy link
Contributor

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.

Quick reference from main GitHub repository page to docs/hacking.pod. Also included community resources for convenience.

Refer to https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors
for GitHub functionality which is activated by this file.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant