jjmccollum / teiphy

A Python package for converting TEI XML collations to NEXUS, BEAST 2.7 XML, and other formats
MIT License
11 stars 3 forks source link

add code of conduct and contributing info #16

Closed rbturnbull closed 2 years ago

jjmccollum commented 2 years ago

I may need some more information on what I need to do for this.

rbturnbull commented 2 years ago

It's good for open source projects to have explicit statements which let people know your expectations for how they can contribute in a file called CONTRIBUTING.md/rst and guidelines which express how people should behave in a CODE_OF_CONDUCT.md/rst. For the code of conduct, I usually use the Contributor Covenant which seems pretty sensible: https://www.contributor-covenant.org/ There are other standard documents out there. Here's an example of a CONTRIBUTING.rst that I've used: https://github.com/rbturnbull/fastapp/blob/main/CONTRIBUTING.rst

jjmccollum commented 2 years ago

These look good to me! Since both documents are at the top level of the repo, should they both be Markdown files, or is there a reason to use RST for the CONTRIBUTING file?

rbturnbull commented 2 years ago

I reuse both files in the docs usually. You can have them as rst or md files. We can add a plugin for sphinx to read markdown.