You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I just learned that GitHub supports defining a default contributing guide and code of conduct for a whole organization, by putting these in a .github repository. I think it might be good to do that for coq-community. It was the idea from the beginning anyway, that this contributing guide and code of conduct applied to all coq-community projects, and that's why we include them in the README template.
This move could be an opportunity to revise the content of the contributing guide: "Proposing a new package" could be moved after "Contributing to a coq-community package", and could mention that each package has its own license. "Contributing to this meta-project" could be renamed into "Contributing to the coq-community organization as a whole" or something like that.
We can also add a generic SUPPORT.md file, which could include the link to coq-community's Gitter room, as well as the Coq Discourse forum (I dunno if that would be useful or not).
Finally, we can also have default issue and pull request templates, but the issue templates from this repository are too specific and thus not a good basis for a default.
Related to this .github repository, there is a new feature allowing to have a README for the entire organization: https://github.blog/changelog/2021-09-14-readmes-for-organization-profiles/
This is probably something worth having (it gives way more flexibility in introducing the organization than just pinning the manifesto repo and linking to the website).
That's something that I had considered at some point, but it wouldn't work because the manifesto repository has specific issue templates for proposing a package or changing maintainers that wouldn't be suitable as a default template.
It looks like the organization wide README could be more of quick summary of coq-community with links to some high-profile projects. More of a marketing thing than a formal statement of goals and rules. I also don't mind if the contribution guide and code of conduct migrates to .github, arguably they are derived from the manifesto README.
Meta-issue
I just learned that GitHub supports defining a default contributing guide and code of conduct for a whole organization, by putting these in a
.github
repository. I think it might be good to do that for coq-community. It was the idea from the beginning anyway, that this contributing guide and code of conduct applied to all coq-community projects, and that's why we include them in the README template.This move could be an opportunity to revise the content of the contributing guide: "Proposing a new package" could be moved after "Contributing to a coq-community package", and could mention that each package has its own license. "Contributing to this meta-project" could be renamed into "Contributing to the coq-community organization as a whole" or something like that.
We can also add a generic
SUPPORT.md
file, which could include the link to coq-community's Gitter room, as well as the Coq Discourse forum (I dunno if that would be useful or not).Finally, we can also have default issue and pull request templates, but the issue templates from this repository are too specific and thus not a good basis for a default.
Reference: https://help.github.com/en/articles/creating-a-default-community-health-file-for-your-organization
The text was updated successfully, but these errors were encountered: