From 2e009d061f5800784cd4a61e0c635c41d0bc5438 Mon Sep 17 00:00:00 2001 From: Bozhidar Batsov Date: Sat, 9 Dec 2023 11:35:49 +0100 Subject: [PATCH] Add a few GitHub-specific files --- .github/FUNDING.yml | 7 +++++++ .github/ISSUE_TEMPLATE.md | 28 +++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 16 ++++++++++++++++ .github/workflows/test.yml | 33 ++++++++++++++++++++++++++++++++ 4 files changed, 84 insertions(+) create mode 100644 .github/FUNDING.yml create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/workflows/test.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..a318a15 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,7 @@ +# These are supported funding model platforms + +github: bbatsov +patreon: bbatsov +ko_fi: bbatsov +liberapay: bbatsov +custom: https://www.paypal.me/bbatsov diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..ff27689 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,28 @@ +*Use the template below when reporting bugs. Please, make sure that +you're running the latest stable Projectile and that the problem you're reporting +hasn't been reported (and potentially fixed) already.* + +**Remove all of the placeholder text in your final report!** + +## Expected behavior + +## Actual behavior + +## Steps to reproduce the problem + +*This is extremely important! Providing us with a reliable way to reproduce +a problem will expedite its solution.* + +## Environment & Version information + +### super-save version + +*E.g. 0.4* + +### Emacs version + +*E.g. 24.5* (use C-h C-a to see it) + +### Operating system + +*E.g. Windows 10* diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..99e8555 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +**Replace this placeholder text with a summary of the changes in your PR. +The more detailed you are, the better.** + +----------------- + +Before submitting a PR make sure the following things have been done (and denote this +by checking the relevant checkboxes): + +- [ ] The commits are consistent with our [contribution guidelines](../blob/master/CONTRIBUTING.md) +- [ ] You've added tests (if possible) to cover your change(s) +- [ ] All tests are passing ([`eldev test`](https://github.com/doublep/eldev)) +- [ ] The new code is not generating bytecode or `M-x checkdoc` warnings +- [ ] You've updated the [changelog](../blob/master/CHANGELOG.md) (if adding/changing user-visible functionality) +- [ ] You've updated the readme (if adding/changing user-visible functionality) + +Thanks! diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..02032a7 --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,33 @@ +name: CI + +on: + push: + paths-ignore: ['**.md', '**.adoc'] + pull_request: + paths-ignore: ['**.md', '**.adoc'] + +jobs: + test: + runs-on: ubuntu-latest + continue-on-error: ${{matrix.emacs_version == 'snapshot'}} + + strategy: + matrix: + # Earliest supported + latest in each stable branch + snapshot. + emacs_version: ['25.1', '25.3', '26.3', '27.1', '28.1', 'snapshot'] + + steps: + - name: Set up Emacs + uses: purcell/setup-emacs@master + with: + version: ${{matrix.emacs_version}} + + - name: Install Eldev + run: curl -fsSL https://raw.github.com/doublep/eldev/master/webinstall/github-eldev | sh + + - name: Check out the source code + uses: actions/checkout@v2 + + - name: Lint the project + run: | + eldev -dtT -C compile --warnings-as-errors