Skip to content

Commit

Permalink
Add issue and pr templates. Rename workflow file.
Browse files Browse the repository at this point in the history
  • Loading branch information
cperlman committed Nov 6, 2023
1 parent c1b7d1d commit e654ca9
Show file tree
Hide file tree
Showing 4 changed files with 116 additions and 5 deletions.
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Bug report
about: File a bug/issue
title: '[BUG] <title>'
labels: bug
assignees: ''
---

<!-- Thanks for reporting a problem!
The more information you can provide us, the faster we can address your problem.
-->

## Short description
<!--
Any information you think might be helpful. Examples include the environment
you built and ran on, what method you invoked, the input you provided and
anything else you think might be relevant.
-->

## Steps to Reproduce
<!--
How to trigger the error.
-->

## Expected behavior
<!--
Describe what you expected to happen.
-->

## Additional context
<!--
Anything else you think we should know.
-->
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Feature request
about: Submit a request for an improvement or new functionality
title: '[Feature Request] <title>'
labels: enhancement
assignees: ''
---

<!-- Thanks for submitting a feature request!
The more information you can provide us, the faster we can address your problem. -->

## What is the underlying problem you would like to see solved?
<!--
By making this change, what are you hoping to improve or fix?
Why would this change make for a better product and/or user experience?
-->

## Describe the ideal solution
<!--
In the ideal scenario, i.e. one where you have all the resources in the world, what would the optimal solution to this problem look like?
-->

## Describe a sufficient solution
<!--
Sadly, we can't have it all. Describe what a minimum viable solution would look like; what is a must-have and what is just a nice-to-have?
-->

## Additional context
<!--
Any additional information that might help, such as links to similar solutions and relevant publications.
-->
51 changes: 51 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
<!--
Thanks for submitting a PR!
Before pressing 'Create pull request' please read the checklist below.
* All code changes should be accompanied by tests. If you are not
modifying any tests, provide a short explanation of why.
* All changes to public APIs **must** be accompanied by
docs.
* Commit messages should explain _why_ you made the changes, not just what
you changed. Use an active, imperative voice and keep the subject line short.
* We strongly encourage you to sign all commits, if possible.
For more information on contributing, check the [guidelines](../CONTRIBUTING.md).
-->

### What changes are made in this PR?

<!--
Include a short description of what changes were made.
-->

### Why are these changes needed?

<!--
Include a short description of why the changes were made.
-->


### Notes for reviewers:

<!--
Information that you think is pertinent for reviewers.
-->

### Additional information:

<!--
Anything else you want to be known or think merits discussion in the context of this PR.
-->

### Related issues:

<!--
Links to issues that will be closed by this PR, if any.
-->
6 changes: 1 addition & 5 deletions .github/workflows/go.yml → .github/workflows/go.yaml
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@
# This workflow will build a golang project
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go

name: Go
name: go_build

on: [push, pull_request]

jobs:

build:
runs-on: ubuntu-latest
steps:
Expand Down

0 comments on commit e654ca9

Please sign in to comment.