CollectionBuilder / collectionbuilder-csv

CollectionBuilder-CSV is a "stand alone" template for creating digital collection and exhibit websites using Jekyll and a metadata CSV.
MIT License
21 stars 16 forks source link

Issue templates, code of conduct etc. #57

Closed maehr closed 8 months ago

maehr commented 1 year ago

I'd love to add some features to this repo:

PS: Here's a full fledged example https://github.com/maehr/github-template of these things.

evanwill commented 1 year ago

Thank you for bringing this up @maehr! Some of the community docs are located in different locations (and apparently not linked to):

Do you think we should have a copy of each document in every CB repository or does it make sense to keep a central copy and link to it?

What are you thinking about for improving the README? Basically just ensuring that the template sections are covered?

maehr commented 1 year ago

I'm a big fan of standalone repos. Redundancy helps regarding SEO, GitHub Insights https://github.com/CollectionBuilder/collectionbuilder-csv/community and is in accordance with https://endings.uvic.ca/principles.html.

The readme could be a bit more detailed about the CB ecosystem and the roadmap (which is helpful for both newbies and pros). Don't you think?

maehr commented 1 year ago

PS: Issue and PR templates are very helpful for maintainers and contributors alike. They help structuring and triaging ideas: https://github.com/maehr/github-template/issues/new/choose or more specifically https://github.com/maehr/open-data-template/issues/new/choose

evanwill commented 1 year ago

I added in the CODE_OF_CONDUCT.md and CONTRIBUTING.md from the central project. @juliastone0729 is reviewing the code of conduct to see if we should work on any updates--let us know if you have specific resources worth looking at for that, beyond your template example.

@maehr what do you think would be in SECURITY.md for a project like this? Basically just providing a contact? @maehr would you like to work on a draft of the Issue templates? I think it is a good idea to provide some structure, but also need to balance it with turning away novice users (which is our audience)--we want to make sure it is welcoming.

maehr commented 1 year ago

@evanwill I would love to work on a draft for the issues. I will open a PR shortly. For the SECURITY.md a contact method will suffice IMHO.

evanwill commented 8 months ago

closing as completed