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

Organization wide contributing guide and code of conduct. #66

Open
Zimmi48 opened this issue May 24, 2019 · 4 comments
Open

Organization wide contributing guide and code of conduct. #66

Zimmi48 opened this issue May 24, 2019 · 4 comments
Labels
meta To ask questions / discuss about the organization / process of coq-community.

Comments

@Zimmi48
Copy link
Member

Zimmi48 commented May 24, 2019

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

@Zimmi48 Zimmi48 added the meta To ask questions / discuss about the organization / process of coq-community. label May 24, 2019
@Zimmi48
Copy link
Member Author

Zimmi48 commented Dec 20, 2021

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).

@liyishuai
Copy link
Member

Consider "renaming" manifesto to .github? I see few reason for having two repos.

@Zimmi48
Copy link
Member Author

Zimmi48 commented Dec 20, 2021

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.

@palmskog
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta To ask questions / discuss about the organization / process of coq-community.
Projects
None yet
Development

No branches or pull requests

3 participants