Skip to content

Commit

Permalink
add github
Browse files Browse the repository at this point in the history
  • Loading branch information
Giorgio Zoppi committed Feb 17, 2024
1 parent 6019a7c commit fa46144
Show file tree
Hide file tree
Showing 7 changed files with 145 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
github: ortuman
patreon: ortuman
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!--
Thank you for reporting an issue.
Please fill in as much of the template below as you're able.
Version: output of `jackal --version`
Platform: output of `uname -a`
Subsystem: if known, please specify affected core module name
If possible, please provide code that demonstrates the problem, keeping it as
simple and free of external dependencies as you are able.
-->

* **Version**: <!-- compulsory. you must provide your version -->
* **Platform**: <!-- `uname -a` output -->
* **Subsystem**: <!-- optional. if known - please specify affected core module name -->

<!-- Enter your issue details below this comment. -->
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: "\U0001F41B Bug report"
about: Create a report to help us improve

---

<!--
Thank you for reporting a possible bug in jackal.
Please fill in as much of the template below as you can.
Version: output of `jackal --version`
Platform: output of `uname -a`
Subsystem: if known, please specify the affected core module name
If possible, please provide code that demonstrates the problem, keeping it as
simple and free of external dependencies as you can.
-->

* **Version**:
* **Platform**:
* **Subsystem**:

<!-- Please provide more details below this comment. -->
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: "\U0001F680 Feature request"
about: Suggest an idea for this project

---

<!--
Thank you for suggesting an idea to make jackal better.
Please fill in as much of the template below as you're able.
-->

**Is your feature request related to a problem? Please describe.**
Please describe the problem you are trying to solve.

**Describe the solution you'd like**
Please describe the desired behavior.

**Describe alternatives you've considered**
Please describe alternative solutions or features you have considered.
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/3-help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
name: "⁉️ Need help with jackal?"
about: Please ask your question

---

25 changes: 25 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<!--
Thank you for your pull request. Please provide a description above and review
the requirements below.
Bug fixes and new features should include tests and possibly benchmarks.
-->

<!-- _Please make sure to review and check all of these items:_ -->


##### Checklist
<!-- Remove items that do not apply. For completed items, change [ ] to [x]. -->

- [ ] `make test` passes
- [ ] tests and/or benchmarks are included
- [ ] documentation is changed or added

<!-- _NOTE: these things are not required to open a PR and can be done afterwards / while the PR is open._ -->

### Affected core subsystem(s)
<!-- Please provide affected core subsystem(s). -->

### Description of change
<!-- Please provide a description of the change here. -->
50 changes: 50 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: CI

on:
push:
pull_request:

jobs:
check:
name: check
runs-on: ubuntu-latest
steps:
- name: Check out code
uses: actions/checkout@v1

- name: Setup Go
uses: actions/setup-go@v2
with:
go-version: '>=1.18'

- name: Setup Go linter
run: go install golang.org/x/tools/cmd/goimports@latest && go install golang.org/x/lint/golint@latest

- name: Setup moq
run: go install github.com/matryer/moq@latest

- name: Run checks
run: make check

test:
name: test
runs-on: ubuntu-latest
steps:
- name: Check out code
uses: actions/checkout@v1

- name: Setup Go
uses: actions/setup-go@v2
with:
go-version: '>=1.18'

- name: Setup moq
run: go install github.com/matryer/moq@latest

- name: Run tests
run: make test

- name: Upload coverage report
uses: codecov/codecov-action@v1.2.1
with:
file: coverage.txt

0 comments on commit fa46144

Please sign in to comment.