-
-
Notifications
You must be signed in to change notification settings - Fork 20
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
Standard template for Contributing on other repos #218
Comments
Here's a proposed template based on ones we already have: Contributing GuidelinesWe love improvements to our tools! EDGI has general guidelines for contributing and a code of conduct for all of our organizational repos. Here are some notes specific to this project:Use this section for any contributing guidelines specific to the repo. For example:
|
We should link (or include) the style guide for the code, if there is any. |
This template looks great! +1 adding style guide as example in template. See umbrella web-monitoring repo |
That makes sense. Style guide is considered to be per-repo rather than an EDGI standard? |
The web monitoring one applies to all My ideal would be potentially per-repo, but in most cases many repos would share (e.g. one guide for all web monitoring repos). I think we’d have a hard time agreeing on rules across all EDGI repos, but maybe I’m being pessimistic. |
|
As part of fulfilling #179 (make sure all active repos have contributing guidelines) I started looking at what repos do/don't have guidelines.Lots of them don't (see the repo audit at #217)! The ones that do have them don't match but express different useful ideas– let's make a template for what CONTRIBUTING.md should look like based on the strengths of the various boilerplates and put it in the template discussed in #170To complete, we should have a standard Contributing.md that refs back to the canonical one, then check that it's applied to each of:Update: standard can be found at https://github.com/edgi-govdata-archiving/overview/blob/master/repo_guidelines.md#minimal-contributing-guidelines– to resolve, simply apply the template to the below repos!
The text was updated successfully, but these errors were encountered: