From b3b82c7f1e47cd0bbff325533d62a91ccad34268 Mon Sep 17 00:00:00 2001 From: Seth Vargo Date: Mon, 27 Sep 2021 20:33:43 -0400 Subject: [PATCH] chore: Add issue/pr templates, note test failures likely (#19) --- .github/ISSUE_TEMPLATE/bug.md | 33 +++++++++++++++++ .github/ISSUE_TEMPLATE/feature.md | 28 +++++++++++++++ .github/ISSUE_TEMPLATE/question.md | 9 +++++ .../pull_request_template.md | 8 +++++ CONTRIBUTING.md | 35 +++++++++++++++++++ 5 files changed, 113 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/feature.md create mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 0000000..7cb20c0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,33 @@ +--- +name: Bug report +about: Tell us about a bug. +labels: bug +--- + +### TL;DR + + +**Expected behavior** + + +**Observed behavior** + + + +### Reproduction + +**Action YAML** + + +```yaml +# Paste your complete GitHub Actions YAML here, removing +# any sensitive values. +``` + +**Repository** + + + + +**Additional information** + diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md new file mode 100644 index 0000000..9d3ba81 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -0,0 +1,28 @@ +--- +name: Feature +about: Request a new feature or functionality. +labels: feature +--- + +### TL;DR + + + +### Design + +**Action YAML** + + + +```yaml +# Paste your proposed GitHub Actions YAML here. +``` + +**Resources** + + +- [Link to documentation](TODO) + + +**Additional information** + diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..1543b2b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,9 @@ +--- +name: Question +about: Ask us a question. +labels: question +--- + +### Question + + diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 0000000..2fbb5b8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,8 @@ + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0a99783 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,35 @@ +# How to contribute + +We'd love to accept your patches and contributions to this project. There are +just a few small guidelines you need to follow. + +## Contributor License Agreement + +Contributions to this project must be accompanied by a Contributor License +Agreement. You (or your employer) retain the copyright to your contribution, +this simply gives us permission to use and redistribute your contributions as +part of the project. Head over to to see +your current agreements on file or to sign a new one. + +You generally only need to submit a CLA once, so if you've already submitted one +(even if it was for a different project), you probably don't need to do it +again. + +## Branching Model + +This repository uses the [Gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) branching model. + +## Code reviews + +All submissions, including submissions by project members, require review. We +use GitHub pull requests for this purpose. Consult +[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more +information on using pull requests. + +**Your tests will likely fail when you open a Pull Request!** This is due to how +GitHub exposes secrets in Pull Requests from forks for non-contributors. Someone +from the team will review your Pull Request and respond. + +## Style Guide + +This project conforms to the [Google JavaScript Style Guide](https://google.github.io/styleguide/jsguide.html). All submitted PRs will be required to conform to this style guide before being merged.