-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add bug and feature request issue templates
- Implement new GitHub issue template for bug reports, guiding users to provide essential details such as evergit and Node.js versions, steps for reproduction, and additional context. - Add feature request template to standardize feature suggestion submissions with required fields for description and motivation. - Update publish workflow to trigger on changes in 'src/' directory and amended indentation for clarity. Release-Note: Add GitHub issue templates for bug reports and feature requests Signed-off-by: Ian Skelskey <ianskelskey@gmail.com>
- Loading branch information
1 parent
87c1ec5
commit 89cbc97
Showing
3 changed files
with
122 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
name: Bug report | ||
description: Report a bug in evergit | ||
title: "[BUG] " | ||
labels: ["bug"] | ||
|
||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for taking the time to fill out this bug report! | ||
- type: input | ||
id: evergit_version | ||
attributes: | ||
label: evergit version | ||
description: Please provide the version of evergit you are using. | ||
placeholder: "e.g. 1.0.0" | ||
|
||
- type: input | ||
id: node_version | ||
attributes: | ||
label: Node version | ||
description: Please provide the version of Node.js you are using. | ||
placeholder: "e.g. 14.17.0" | ||
|
||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Bug description | ||
description: Please provide a clear and concise description of the bug. | ||
placeholder: "Describe the bug" | ||
|
||
- type: textarea | ||
id: steps_to_reproduce | ||
attributes: | ||
label: Steps to reproduce | ||
description: Please provide the steps to reproduce the bug. | ||
placeholder: "Steps to reproduce" | ||
|
||
- type: textarea | ||
id: expected_behavior | ||
attributes: | ||
label: Expected behavior | ||
description: Please describe what you expected to happen. | ||
placeholder: "Describe the expected behavior" | ||
|
||
- type: textarea | ||
id: additional_context | ||
attributes: | ||
label: Additional context | ||
description: Add any other context about the problem here. For example, screenshots, logs, etc. | ||
placeholder: "Add any other context about the problem here" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
name: Feature request | ||
description: Suggest an idea for this project | ||
title: "[FEATURE] " | ||
labels: ["enhancement"] | ||
|
||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for taking the time to open a feature request! Please provide us with as much detail as possible to help us understand your idea. | ||
- type: input | ||
id: feature | ||
attributes: | ||
label: Feature description | ||
description: Please describe the feature you would like to see | ||
placeholder: Describe the feature here | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: motivation | ||
attributes: | ||
label: Motivation | ||
description: Why do you want this feature? What problem does it solve? | ||
placeholder: Explain why this feature should be implemented | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
id: alternatives | ||
attributes: | ||
label: Alternatives | ||
description: Are there any alternative solutions or features you've considered? | ||
placeholder: Describe any alternative solutions here | ||
|
||
- type: textarea | ||
id: additional-context | ||
attributes: | ||
label: Additional context | ||
description: Add any other context or screenshots about the feature request here | ||
placeholder: Add any other context or screenshots here |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,36 +1,38 @@ | ||
name: Publish to npm | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
push: | ||
branches: | ||
- main | ||
paths: | ||
- 'src/**' | ||
|
||
jobs: | ||
publish: | ||
runs-on: ubuntu-latest | ||
publish: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
# Step 1: Checkout the code from the repository | ||
- name: Checkout code | ||
uses: actions/checkout@v3 | ||
steps: | ||
# Step 1: Checkout the code from the repository | ||
- name: Checkout code | ||
uses: actions/checkout@v3 | ||
|
||
# Step 2: Set up Node.js environment | ||
- name: Set up Node.js | ||
uses: actions/setup-node@v3 | ||
with: | ||
node-version: '20' | ||
registry-url: 'https://registry.npmjs.org/' | ||
# Step 2: Set up Node.js environment | ||
- name: Set up Node.js | ||
uses: actions/setup-node@v3 | ||
with: | ||
node-version: '20' | ||
registry-url: 'https://registry.npmjs.org/' | ||
|
||
# Step 3: Install dependencies | ||
- name: Install dependencies | ||
run: npm install | ||
# Step 3: Install dependencies | ||
- name: Install dependencies | ||
run: npm install | ||
|
||
# Step 4: Build the project | ||
- name: Build the project | ||
run: npm run build | ||
# Step 4: Build the project | ||
- name: Build the project | ||
run: npm run build | ||
|
||
# Step 5: Publish to npm | ||
- name: Publish to npm | ||
run: npm publish | ||
env: | ||
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} | ||
# Step 5: Publish to npm | ||
- name: Publish to npm | ||
run: npm publish | ||
env: | ||
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} |