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

chore: add pull request and issue templates #164

Merged
merged 7 commits into from
Oct 6, 2021

Conversation

shivlaks
Copy link
Contributor

Description

Added in some templates for issues and a checklist for pull-requests, inspired by the CDK.

Issue templates

These templates will be used for users who create Issues for the repo. Users will
be presented with options based on whether they are filing a feature-request, bug, or doc.

Pull request template:

This template will be applied whenever a pull request is

Note: one difference between the current message is that the licensing text has been updated
to reflect the license we use in the repo

Templates are pretty self-explanatory in terms of the details we will request.

Open

  • We may need to make some updates to CONTRIBUTING guide but wanted to settle on content first
    • i.e. do we want to follow conventional commits - i just kind of threw that in the PR checklist
  • How is the current PR boilerplate content generated? I think it's default but want to confirm we haven't configured it anywhere

The questions/directives are somewhat opinionated, but your opinion matters the most. drop a comment 👇 and I'll work it in


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@shivlaks shivlaks changed the title Shivlaks/pr issue templates chore: add pull request and issue templates Sep 11, 2021
ca-nguyen
ca-nguyen previously approved these changes Sep 14, 2021
Copy link
Contributor

@ca-nguyen ca-nguyen left a comment

Choose a reason for hiding this comment

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

Loving this! Thanks for adding these templates!

Great to see the issue templates - standardizing the way the information is presented will help improve investigation time and communication!

Adding a PR checklist ensures all steps have been covered before a PR is submitted and will shorten the review process. 🚢

wong-a
wong-a previously approved these changes Sep 27, 2021
Co-authored-by: Adam Wong <55506708+wong-a@users.noreply.github.com>
@shivlaks shivlaks dismissed stale reviews from wong-a and ca-nguyen via a2a0b6b September 29, 2021 19:08
@StepFunctions-Bot
Copy link
Contributor

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject6AEA49D1-sEHrOdk7acJc
  • Commit ID: 5cf32a8
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@shivlaks shivlaks requested review from wong-a and ca-nguyen October 5, 2021 17:20
@shivlaks shivlaks merged commit 58bed5d into main Oct 6, 2021
@shivlaks shivlaks deleted the shivlaks/pr-issue-templates branch October 6, 2021 22:08
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.

4 participants