Giter Club home page Giter Club logo

Comments (4)

jjmccollum avatar jjmccollum commented on August 24, 2024

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

from teiphy.

rbturnbull avatar rbturnbull commented on August 24, 2024

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

from teiphy.

jjmccollum avatar jjmccollum commented on August 24, 2024

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?

from teiphy.

rbturnbull avatar rbturnbull commented on August 24, 2024

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.

from teiphy.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.