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

Add contributor related files to repo #170

Open
jpswinski opened this issue Jan 5, 2023 · 6 comments
Open

Add contributor related files to repo #170

jpswinski opened this issue Jan 5, 2023 · 6 comments

Comments

@jpswinski
Copy link
Member

Provide a CONTRIBUTING.md, COMMITERS.md, and CODE_OF_CONDUCT.md file in the repo to support and recognize outside contributors.

@jpswinski
Copy link
Member Author

Applicable to other public repos as well.

@jhkennedy
Copy link
Contributor

@jpswinski I believe you can place CONTRIBUTING.md and CODE_OF_CONDUCT.md in the special ISCESat-2-SlideRule/.github repo and they will be applied to the Org by default but can be overridden by ones in individual repos. Same with other "community health" files like issue and PR templates.

https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file

@dshean
Copy link
Member

dshean commented Jan 19, 2023

Perfect! @jpswinski I created this .github repo for our org (currently contains README.md for the org page). I'm testing now with CITATION.md

@dshean
Copy link
Member

dshean commented Jan 19, 2023

Ah...looks like they only allow this for limited file types:
https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file#supported-file-types

You cannot create a default license file. License files must be added to individual repositories so the file will be included when a project is cloned, packaged, or downloaded.

@jpswinski
Copy link
Member Author

Thanks @jhkennedy and @dshean - for what they allow, this looks like it is exactly what we want.

@dshean
Copy link
Member

dshean commented Jan 20, 2023

👍
Im thinking we can centralize additional shared md in the .github repo, even if not formally supported. And can just deploy copies to each individual repo manually or with a little script. Maybe some clever way to accomplish with links.

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

No branches or pull requests

3 participants