Skip to content

Conversation

dakinggg
Copy link
Contributor

@dakinggg dakinggg commented Oct 3, 2022

Adds a pull request template.

Examples from other repos:

Common elements from those other repos, for inspiration in case you think my template is missing something:

  • Summary
  • Related issues
  • Breaking changes?
  • Checklist
    • Is there an issue?
    • Did you read contributor guidelines?
    • PR does one thing?
    • Did you update any docs related to this change?
    • Did you write new tests?
    • Did you verify tests pass locally?
    • Update the changelog?
    • Is it a docs change?
  • Reviewing checklist for how to review
  • Something fun (e.g. thank you, meme, joke etc)
  • Description of who to ask for review
  • Pull request type
  • License stuff (e.g. is this change compatible with our license)
  • Link to contributing.md
  • pre-commit instructions

Screenshot of what the markdown looks like (checklist should be rendered properly on github):
Screen Shot 2022-10-03 at 11 56 22 AM

Closes CO-117

@dakinggg dakinggg requested a review from a team as a code owner October 3, 2022 18:57
Copy link
Contributor

@mvpatel2000 mvpatel2000 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, though defer to Hanlin on this. Big question is how external vs. internal we want this to be -- for example, internally we want to tag JIRA issues instead of Github issues. Should the template reflect this? I'm personally fine leaving as github in the template

Copy link
Contributor

@hanlint hanlint left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! I think the issues section we can put our internal JIRAs if needed

@dakinggg
Copy link
Contributor Author

dakinggg commented Oct 3, 2022

Ah yeah, I was definitely writing this more for an external audience, but internally we can put JIRA tickets instead of github issue.

@dakinggg dakinggg merged commit 5c57926 into mosaicml:dev Oct 3, 2022
@dakinggg dakinggg deleted the pr_template branch October 20, 2022 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants