GithubHelp home page GithubHelp logo

Comments (6)

jvanderhoof avatar jvanderhoof commented on May 24, 2024

Maybe we put this into a PR.md file, or something like that.

from conjur.

dustinmm80 avatar dustinmm80 commented on May 24, 2024

Let's use CONTRIBUTING.md because then github will show that to everyone opening a PR on this project. Standards are good.

https://github.com/blog/2111-issue-and-pull-request-templates

from conjur.

jvanderhoof avatar jvanderhoof commented on May 24, 2024

Good call @dustinmm80

from conjur.

dustinmm80 avatar dustinmm80 commented on May 24, 2024

This sentence has me interested

You can put CONTRIBUTING.md, ISSUE_TEMPLATE.md, and PULL_REQUEST_TEMPLATE.md files in .github/ and everything will work as expected.

What does that mean? What is the difference in how GitHub 'surfaces' these into its UI? That would be great to know.

from conjur.

ryanprior avatar ryanprior commented on May 24, 2024

I will verify this, but my impression is:

  • CONTRIBUTING.md is rendered and shown to anybody opening an issue or PR
  • ISSUE_TEMPLATE.md is used in raw form to pre-populate the text box when opening an issue
  • PULL_REQUEST_TEMPLATE.md is used likewise with PRs

I'll start out with a PR template and a CONTRIBUTING doc.

from conjur.

dustinmm80 avatar dustinmm80 commented on May 24, 2024

Closing this, PR #76 has been merged.

from conjur.

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.