Skip to content

Commit

Permalink
docs: Add issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
Nicconike committed Jul 6, 2024
1 parent f08e645 commit 5ea945c
Show file tree
Hide file tree
Showing 8 changed files with 152 additions and 10 deletions.
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Bug Report
description: Report a bug to help me improve goautomate
title: " "
labels: ["bug"]
assignees: "nicconike"
body:
- type: markdown
attributes:
value: |
Please fill out the sections below to help everyone identify and fix the bug
- type: textarea
id: description
attributes:
label: Describe your issue
placeholder: When I run this then this happens
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to reproduce
placeholder: |
1. Go here
2. Import this
3. Run this
validations:
required: true
- type: textarea
id: expected
attributes:
label: What was the expected result?
placeholder: I expected this to happen
- type: textarea
id: screenshots
attributes:
label: Attach here any screenshots, if applicable (optional)
- type: dropdown
id: assign
attributes:
label: "Would you like to work on this issue?"
options:
- "Yes"
- "No"
- type: markdown
attributes:
value: |
Thanks for reporting this issue! I will get back to you as soon as possible.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: Questions
url: https://discord.gg/UbetHfu
about: You can join or create new discussions on Discord.
- name: Script does not work
url: https://github.com/nicconike/goautomate/blob/master/CONTRIBUTING.md
about: Before opening a new issue, please make sure to read CONTRIBUTING.md
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Documentation
description: Suggest improvements or report issues with the documentation
title: " "
labels: ["documentation"]
assignees: "nicconike"
body:
- type: markdown
attributes:
value: |
Please fill out the sections below to properly describe the new change that you are suggesting for the documentation
- type: textarea
id: description
attributes:
label: Describe the documentation change
placeholder: This change will help improve the users understand the doc in a better way
validations:
required: true
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Feature request
description: Suggest an idea for this project
title: " "
labels: ["enhancement"]
assignees: "nicconike"
body:
- type: markdown
attributes:
value: |
Please fill out the sections below to properly describe the new feature you are suggesting
- type: textarea
id: description
attributes:
label: Describe the feature
placeholder: A change in this script to add this feature X
validations:
required: true
- type: textarea
id: rationale
attributes:
label: It should be implemented because
placeholder: It will add this new functionality to the feature
- type: textarea
id: context
attributes:
label: Additional context
placeholder: |
Add any other context or screenshots about the feature request here.
- type: dropdown
id: assign
attributes:
label: "Would you like to work on this issue?"
options:
- "Yes"
- "No"
- type: markdown
attributes:
value: |
Thanks for your suggestion! Let's see together if it can be implemented
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/help-wanted.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Help Wanted
description: Request help for a specific issue or concern
title: " "
labels: ["help wanted"]
assignees: "nicconike"
body:
- type: markdown
attributes:
value: |
Please fill out the sections below to properly describe the new issue
- type: textarea
id: description
attributes:
label: Describe the scenario
placeholder: I am unable to do this, need help!
validations:
required: true
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Question
description: Ask a question about this project
title: " "
labels: ["question"]
assignees: "nicconike"
body:
- type: markdown
attributes:
value: |
Please fill out the sections below to properly describe your question
- type: textarea
id: description
attributes:
label: Describe the question
placeholder: How is this feature implemented? What does this script do?
validations:
required: true
11 changes: 3 additions & 8 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,10 @@ jobs:
changelog-generator-opt: "emojis=true"

- name: Publish to GitHub
if: steps.semrel.outputs.version != ''
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
VERSION=$(git describe --tags --abbrev=0)
echo "module github.com/Nicconike/goautomate" > go.mod
go list -m github.com/Nicconike/goautomate@${{ steps.semrel.outputs.version }}
GOPROXY=proxy.golang.org go list -m github.com/Nicconike/goautomate@${{ steps.semrel.outputs.version }}
- name: Index package on pkg.go.dev
if: steps.semrel.outputs.version != ''
run: |
GOPROXY=proxy.golang.org go list -m github.com/Nicconike/goautomate@${{ steps.semrel.outputs.version }}
go list -m github.com/Nicconike/goautomate@VERSION
GOPROXY=proxy.golang.org go list -m github.com/Nicconike/goautomate@$VERSION
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ This will check the specified file for the current Go version, compare it with t

- `-file`: Path to the file containing the current Go version
- `-version` or `-v`: Directly specify the current Go version
- `-os`: Target operating system (windows, linux, darwin)
- `-arch`: Target architecture (386, amd64, arm64, armv6l)
- `-os`: Target operating system (windows, linux, macOS[darwin])
- `-arch`: Target architecture (386[x86], amd64[x86-64], arm64, armv6l[armv6])

### Examples

Expand Down Expand Up @@ -75,6 +75,8 @@ goautomate can extract Go versions from various file types, including:

The tool uses various patterns to detect Go versions, making it flexible for different project setups.

Missing any file types you expected to see? Let me know

## Contributing

Contributions to goautomate are welcome! Please feel free to submit a Pull Request.
Expand Down

0 comments on commit 5ea945c

Please sign in to comment.