Skip to content

Commit

Permalink
issue and pr templates
Browse files Browse the repository at this point in the history
  • Loading branch information
cblanquera committed Jun 13, 2024
1 parent 5d58d3e commit 27338b8
Show file tree
Hide file tree
Showing 8 changed files with 172 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/01-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Feature Request
description: Create a feature request
labels: ['feature']
body:
- type: markdown
attributes:
value: Thanks for taking the time to file a feature request! Please fill out this form as completely as possible.
- type: markdown
attributes:
value: 'Feature requests will be converted to the GitHub Discussions "Ideas" section.'
- type: textarea
attributes:
label: Describe the feature you'd like to request
description: A clear and concise description of what you want and what your use case is.
validations:
required: true
- type: textarea
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: true
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/02-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: Bug Report
description: Create a bug report
labels: ['bug']
body:
- type: markdown
attributes:
value: Thanks for taking the time to file a bug report! Please fill out this form as completely as possible.
- type: input
attributes:
label: What version of Temple are you using?
description: 'For example: 0.0.13'
validations:
required: true
- type: input
attributes:
label: What OS are you experiencing this issue?
description: 'For example: Windows 10 Pro, MacOS Monterey, Ubuntu 23.10'
validations:
required: true
- type: input
attributes:
label: What Browser are you experiencing this issue?
description: 'For example: Chrome 125.0.6422.141, Safari 17.4.1, Firefox 128.0'
validations:
required: true
- type: textarea
attributes:
label: Describe the Bug
description: A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true
- type: textarea
attributes:
label: To Reproduce
description: Steps to reproduce the behavior, please provide a clear code snippets that always reproduces the issue or a GitHub repository. Screenshots can be provided in the issue body below.
validations:
required: true
- type: input
attributes:
label: Include git repo/fork so we can easily reproduce the issue
description: 'For example: https://github.com/username/repo.git'
validations:
required: false
- type: markdown
attributes:
value: Before posting the issue go through the steps you've written down to make sure the steps provided are detailed and clear.
- type: markdown
attributes:
value: Contributors should be able to follow the steps provided in order to reproduce the bug.
- type: markdown
attributes:
value: These steps are used to add integration tests to ensure the same issue does not happen again. Thanks in advance!
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
32 changes: 32 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<!--
Thanks for opening a PR! Your contribution is much appreciated.
Please make sure you have followed our contributing guidelines. If you
haven't done so in your commits, please reference the issue numbers as
well as the time you spent on this in the comments below so we can track
time. example `fixed button #1001 3h`. In order to make sure your PR is
handled as smoothly as possible we request that you follow the checklist
sections below. Choose the right checklist for the change that you're
making:
-->

## What is this PR for?

- [ ] Just updating content and/or documentation
- [ ] This fixes issue #_____
- [ ] Spot fix *(no issue #)*
- [ ] Merging WIP feature #_____
- [ ] Merging done feature #_____
- [ ] This is a merge from a version branch
- [ ] Adding/Updating tests
- [ ] This is a conflict resolution
- [ ] This is a branch cleanup
- [ ] Other: ________________

## I verify that...

- [ ] I have logged my time in the commits
- [ ] I have logged my time in this PR
- [ ] I have tagged all the relevant issues
- [ ] I am using VS Code for type checks and linting, or
- [ ] I have ran `npm run test` with no errors
- [ ] I have manually checked that this bug or feature is working
17 changes: 17 additions & 0 deletions .github/workflows/comment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Auto Comment
on: [issues, pull_request]
jobs:
run:
runs-on: ubuntu-latest
steps:
-
if: github.event.pull_request.head.repo.full_name == github.repository
uses: wow-actions/[email protected]
with:
GITHUB_TOKEN: ${{ secrets.API_TOKEN_GITHUB }}
issuesOpened: |
👋 @{{ author }}
Thank you for raising an issue! Please make sure you have given as much context as possible. Screenshots are appreciated!
pullRequestOpened: |
👋 @{{ author }}
Thank you for raising your pull request. Please make sure you have followed our contributing guidelines. If you haven't done so in your commits, please reference the issue numbers as well as the time you spent on this in the comments below so we can track time. example `fixed button #1001 3h`
18 changes: 18 additions & 0 deletions .github/workflows/stale.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Close inactive issues
on:
schedule:
- cron: "30 1 * * *"
jobs:
close-issues:
runs-on: ubuntu-latest
steps:
- uses: actions/[email protected]
with:
days-before-issue-stale: 30
days-before-issue-close: 14
stale-issue-label: "stale"
stale-issue-message: "This issue is stale because it has been open for 30 days with no activity."
close-issue-message: "This issue was closed because it has been inactive for 14 days since being marked as stale."
days-before-pr-stale: -1
days-before-pr-close: -1
repo-token: ${{ secrets.API_TOKEN_GITHUB }}
17 changes: 17 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Idea Test Suite
on: [push]
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: '20.x'
- name: Install dependencies
run: yarn
- name: Building code
run: yarn build
- name: Run tests
run: yarn test
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"build:loader": "yarn --cwd packages/temple-loader build",
"build:dev": "yarn --cwd packages/temple-dev build",
"build:web": "yarn --cwd packages/temple-web build",
"test": "yarn test:parser && yarn test:compiler",
"test:parser": "yarn --cwd packages/temple-parser test",
"test:compiler": "yarn --cwd packages/temple-compiler test",
"dev:express": "yarn --cwd examples/with-express dev",
Expand Down

0 comments on commit 27338b8

Please sign in to comment.