chore: Add issue/pr templates, note test failures likely (#19)
This commit is contained in:
parent
7296e5030f
commit
b3b82c7f1e
33
.github/ISSUE_TEMPLATE/bug.md
vendored
Normal file
33
.github/ISSUE_TEMPLATE/bug.md
vendored
Normal file
@ -0,0 +1,33 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Tell us about a bug.
|
||||
labels: bug
|
||||
---
|
||||
|
||||
### TL;DR
|
||||
<!-- Describe the bug in 1-2 sentences below. -->
|
||||
|
||||
**Expected behavior**
|
||||
<!-- What did you expect to happen? Please share below. -->
|
||||
|
||||
**Observed behavior**
|
||||
<!-- What did happened instead? Please share below. -->
|
||||
|
||||
|
||||
### Reproduction
|
||||
|
||||
**Action YAML**
|
||||
<!-- Add your complete GitHub Actions YAML below. -->
|
||||
|
||||
```yaml
|
||||
# Paste your complete GitHub Actions YAML here, removing
|
||||
# any sensitive values.
|
||||
```
|
||||
|
||||
**Repository**
|
||||
<!-- Is your repository public? If so, please link to it. -->
|
||||
<!-- If your repository is not public, delete this section. -->
|
||||
|
||||
|
||||
**Additional information**
|
||||
<!-- Are you running custom workers? Doing something atypical? Etc? -->
|
28
.github/ISSUE_TEMPLATE/feature.md
vendored
Normal file
28
.github/ISSUE_TEMPLATE/feature.md
vendored
Normal file
@ -0,0 +1,28 @@
|
||||
---
|
||||
name: Feature
|
||||
about: Request a new feature or functionality.
|
||||
labels: feature
|
||||
---
|
||||
|
||||
### TL;DR
|
||||
<!-- Describe the feature in 1-2 sentences below. -->
|
||||
|
||||
|
||||
### Design
|
||||
|
||||
**Action YAML**
|
||||
<!-- What do you envision the action to look like? -->
|
||||
<!-- If this is not relevant, delete this section. -->
|
||||
|
||||
```yaml
|
||||
# Paste your proposed GitHub Actions YAML here.
|
||||
```
|
||||
|
||||
**Resources**
|
||||
<!-- Please provide links to relevant documentation or examples. -->
|
||||
|
||||
- [Link to documentation](TODO)
|
||||
|
||||
|
||||
**Additional information**
|
||||
<!-- Are you running custom workers? Doing something atypical? Etc? -->
|
9
.github/ISSUE_TEMPLATE/question.md
vendored
Normal file
9
.github/ISSUE_TEMPLATE/question.md
vendored
Normal file
@ -0,0 +1,9 @@
|
||||
---
|
||||
name: Question
|
||||
about: Ask us a question.
|
||||
labels: question
|
||||
---
|
||||
|
||||
### Question
|
||||
<!-- Ask your question in 1-2 sentences below. -->
|
||||
<!-- If sharing code, please use ``` codeblocks -->
|
8
.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
vendored
Normal file
8
.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
vendored
Normal file
@ -0,0 +1,8 @@
|
||||
<!--
|
||||
|
||||
Thank you for submitting a Pull Request! Please note that YOUR TESTS WILL LIKELY
|
||||
FAIL due to how GitHub exposes secrets in Pull Requests from forks.
|
||||
|
||||
Someone from the team will review your Pull Request and respond.
|
||||
|
||||
-->
|
35
CONTRIBUTING.md
Normal file
35
CONTRIBUTING.md
Normal file
@ -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 <https://cla.developers.google.com/> 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.
|
Loading…
Reference in New Issue
Block a user