search

edgi-govdata-archiving / overview

🎈 Start here for current projects, how to get involved, and joining community calls, a resource for new and veteran members
GNU General Public License v3.0
118 stars 20 forks source link

Create a template resource for repos #170

Closed patcon closed 5 years ago

patcon commented 7 years ago

reticketed from https://github.com/datatogether/roadmap/issues/16#issuecomment-315141403

What about having a template repository, not just a template for CoC? I'm thinking we could create a repo with a clever name like "repo-boilerplate" or "github-template", containing the files that one would normally want to put in each repo: conduct, contributions guidelines, readme, license, maybe some others. When creating a new repo, clone the template rather than creating a blank repo.

h/t @mhucka

did I capture it in the right place?

patcon commented 7 years ago

I had great luck with this tool in the past: https://github.com/audreyr/cookiecutter

Other applications:

mhucka commented 7 years ago

I've seen CookieCutter before but never tried it. Might work for this purpose.

Frijol commented 5 years ago

Per our new stale issues policy:

This issue has been marked as stale because it has not had recent activity. It will be closed in seven days if no further activity occurs. If it should not be closed, please comment! Thank you for your contributions.

In the future, a robot will take care of this process!

Frijol commented 5 years ago

This still seems like a good idea! Do we have a spec somewhere (this repo?) that says what all the things are that should go in each EDGI repo?

lightandluck commented 5 years ago

I haven't seen a spec. But what I've seen copied across repos is CONDUCT, CONTRIBUTING, and LICENSE. Do you have suggestions for other things to include?

I'm also not sure how often we'll be spinning up new repos. It might make sense first to get a list and make sure current repos have everything included.

Frijol commented 5 years ago

Yes, I agree re not spinning up a lot of new repos + wanting to standardize– seems unlikely we'd need to automate at this moment. What about a REPO-TEMPLATE.md in this repo that

Frijol commented 5 years ago

Suggestions for inclusion in standard Readmes:

lightandluck commented 5 years ago

This all looks great and let's go with creating that REPO-TEMPLATE.md file because it would work great as a checklist as we're cleaning all the repos up.

I think after we're done we could create an actual template repo with the 4 files: CONDUCT, CONTRIBUTING, LICENSE and README. README could explain everything and contain all those suggestions. There's probably tons out there, but would be a nice resource for us to share

Frijol commented 5 years ago

Do we typically have a CONDUCT file in our repos? I looked at a few repos but haven't found one yet other than the one in this repo (and reference to it from the CONTRIBUTING files).

Any preference on having it as a separate file that refs back to the canonical one (a la contributing) vs just mentioning it in the readme and contributing guidelines?

Frijol commented 5 years ago

Answering my own question: we do not typically have a CONDUCT file in our repos, but per https://github.com/edgi-govdata-archiving/overview/issues/207#issuecomment-382048478 should reference the canonical one in the Readme.

Bigger note: it appears we already have a template-style resource in our project guidelines– do we want to build from that, separate out to repo-template, other?

Frijol commented 5 years ago

Can I close based on https://github.com/edgi-govdata-archiving/overview/pull/220 or do we want to leave this open pending an automation step?

Personally I lean towards closing it/don't think automation need currently be on our to-do list

lightandluck commented 5 years ago

+1 to closing. Don't think automating is worth it right now