Skip to content

Commit ee161f0

Browse files
olimorrisolimorris
committed
Revert "REMOVE .github"
This reverts commit 8be17f7.
1 parent 1f3d97f commit ee161f0

File tree

10 files changed

+325
-0
lines changed

10 files changed

+325
-0
lines changed

‎.github/FUNDING.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
github: olimorris
2+
buy_me_a_coffee: olimorris

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
name: Bug Report
2+
description: Raise an issue for something that is stopping CodeCompanion from working as expected
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
**Before** reporting an issue, make sure to read the [documentation](https://codecompanion.olimorris.dev) and search [existing issues](https://github.com/olimorris/codecompanion.nvim/issues)
11+
12+
**What is a bug?**
13+
- A bug is a reproducible error that causes CodeCompanion to behave incorrectly, crash, or not work as documented
14+
- Minor cosmetic issues (such as extra line breaks or formatting quirks) are not considered bugs unless they impact usability or readability. Please PR any of these changes yourself
15+
- Feature requests, usage questions, or configuration help should go to [Discussions](https://github.com/olimorris/codecompanion.nvim/discussions)
16+
17+
> [!IMPORTANT]
18+
> If you don't supply a valid `minimal.lua` your issue will be closed
19+
20+
- type: checkboxes
21+
attributes:
22+
label: Pre-submission checklist
23+
description: Please confirm all of the following before submitting
24+
options:
25+
- label: I have read the [documentation](https://codecompanion.olimorris.dev)
26+
required: true
27+
- label: I have updated the plugin and all dependencies to the latest versions
28+
required: true
29+
- label: I have searched for existing [issues](https://github.com/olimorris/codecompanion.nvim/issues) and [discussions](https://github.com/olimorris/codecompanion.nvim/discussions)
30+
required: true
31+
- label: My issue is not a minor or cosmetic quirk (e.g., formatting, spacing, or other non-functional details)
32+
required: true
33+
34+
- type: input
35+
attributes:
36+
label: "Neovim version (nvim -v)"
37+
placeholder: "0.8.0 commit db1b0ee3b30f"
38+
validations:
39+
required: true
40+
41+
- type: input
42+
attributes:
43+
label: "Operating system/version"
44+
placeholder: "macOS 14.4, Ubuntu 22.04, Windows 11"
45+
validations:
46+
required: true
47+
48+
- type: input
49+
attributes:
50+
label: "Adapter and model"
51+
placeholder: "Copilot and GPT-4.1"
52+
validations:
53+
required: true
54+
55+
- type: textarea
56+
attributes:
57+
label: Describe the bug
58+
description: |
59+
A clear and concise description of the problem
60+
Include any error messages or unexpected behavior you observe
61+
placeholder: |
62+
When I do X ...
63+
I observe Y ...
64+
But I expect Z ...
65+
validations:
66+
required: true
67+
68+
- type: textarea
69+
attributes:
70+
label: Steps to reproduce
71+
description: |
72+
List the steps to reproduce the issue
73+
Be as minimal and precise as possible
74+
placeholder: |
75+
1. Open Neovim with the provided minimal.lua
76+
2. ...
77+
3. ...
78+
validations:
79+
required: true
80+
81+
- type: textarea
82+
attributes:
83+
label: Expected behavior
84+
description: What do you expect to happen?
85+
placeholder: |
86+
I expected ...
87+
validations:
88+
required: true
89+
90+
- type: textarea
91+
attributes:
92+
label: Screenshots or recordings (optional)
93+
description: If applicable, add screenshots or a screen recording to help explain your problem
94+
validations:
95+
required: false
96+
97+
- type: markdown
98+
attributes:
99+
value: |
100+
## Reproduce the issue
101+
102+
- Please provide a `minimal.lua` file that reproduces the issue
103+
- I'm a solo maintainer, so making my life easy means a lot
104+
- Preferably use the one [here](https://github.com/olimorris/codecompanion.nvim/blob/main/minimal.lua)
105+
- Save it as `minimal.lua` and run with `nvim -u minimal.lua`
106+
- All files will be downloaded to a `.repro` folder in your current working directory
107+
108+
- type: textarea
109+
attributes:
110+
label: minimal.lua file
111+
render: lua
112+
validations:
113+
required: true
114+
115+
- type: textarea
116+
attributes:
117+
label: Log output (optional)
118+
description: |
119+
Share the output from `.repro/state/nvim/codecompanion.log` if available
120+
Please redact any sensitive information
121+
validations:
122+
required: false
123+
124+
- type: checkboxes
125+
attributes:
126+
label: Minimal reproduction confirmation
127+
description: I have provided and tested with a `minimal.lua` file as described above
128+
options:
129+
- label: Yes, I have tested and provided a `minimal.lua` file that reproduces the issue
130+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Get Help
4+
url: https://github.com/olimorris/codecompanion.nvim/discussions/new?category=q-a
5+
about: Help with your config? UI quirks? Or, you just can't get something to work the way you expect, open a question in our discussion forums.
6+
- name: Feature Request
7+
url: https://github.com/olimorris/codecompanion.nvim/discussions/new?category=ideas
8+
about: Suggest any ideas you have using our discussion forums.

‎.github/pull_request_template.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## Description
2+
3+
<!-- Describe the big picture of your changes to communicate to the maintainers why we should accept this pull request. -->
4+
5+
## Related Issue(s)
6+
7+
<!--
8+
If this PR fixes any issues, please link to the issue here.
9+
- Fixes #<issue_number>
10+
-->
11+
12+
## Screenshots
13+
14+
<!-- Add screenshots of the changes if applicable, to help visualize the change. -->
15+
16+
## Checklist
17+
18+
- [ ] I've read the [contributing](https://github.com/olimorris/codecompanion.nvim/blob/main/CONTRIBUTING.md) guidelines and have adhered to them in this PR
19+
- [ ] I've updated `CodeCompanion.has` in the [init.lua](https://github.com/olimorris/codecompanion.nvim/blob/main/lua/codecompanion/init.lua#L239) file for my new feature
20+
- [ ] I've added [test](https://github.com/olimorris/codecompanion.nvim/blob/main/CONTRIBUTING.md#testing) coverage for this fix/feature
21+
- [ ] I've updated the README and/or relevant docs pages
22+
- [ ] I've run `make all` to ensure docs are generated, tests pass and my formatting is applied

‎.github/workflows/ci.yml‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Continuous Integration
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request: ~
8+
9+
concurrency:
10+
group: ${{ github.workflow }}-${{ github.event_name == 'pull_request' && github.head_ref || github.sha }}
11+
cancel-in-progress: true
12+
13+
jobs:
14+
tests:
15+
runs-on: ${{ matrix.os }}
16+
strategy:
17+
fail-fast: false
18+
matrix:
19+
include:
20+
- os: ubuntu-latest
21+
url: https://github.com/neovim/neovim/releases/download/nightly/nvim-linux-x86_64.tar.gz
22+
- os: ubuntu-latest
23+
url: https://github.com/neovim/neovim/releases/download/v0.11.0/nvim-linux-x86_64.tar.gz
24+
25+
steps:
26+
- name: Checkout 🛎️
27+
uses: actions/checkout@v4
28+
29+
- run: date +%F > todays-date
30+
31+
- name: Restore from todays cache 📂
32+
uses: actions/cache@v4
33+
with:
34+
path: _neovim
35+
key: ${{ runner.os }}-${{ matrix.url }}-${{ hashFiles('todays-date') }}
36+
37+
- name: Prepare 🏗️
38+
run: |
39+
sudo apt-get install ripgrep
40+
test -d _neovim || {
41+
mkdir -p _neovim
42+
curl -sL ${{ matrix.url }} | tar xzf - --strip-components=1 -C "${PWD}/_neovim"
43+
}
44+
mkdir -p ~/.local/share/nvim/site/pack/vendor/start
45+
ln -s $(pwd) ~/.local/share/nvim/site/pack/vendor/start
46+
47+
- name: Run tests 🧪
48+
run: |
49+
export PATH="${PWD}/_neovim/bin:${PATH}"
50+
export VIM="${PWD}/_neovim/share/nvim/runtime"
51+
nvim --version
52+
make test
53+

‎.github/workflows/format.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Format with StyLua
2+
3+
on: [pull_request]
4+
5+
jobs:
6+
stylua:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- name: Checkout 🛎️
10+
uses: actions/checkout@v4
11+
12+
- name: Format 🖌️
13+
uses: JohnnyMorganz/stylua-action@v4
14+
with:
15+
token: ${{ secrets.GITHUB_TOKEN }}
16+
version: v2.0.2
17+
args: --check .
18+

‎.github/workflows/release.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Release
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
release:
10+
runs-on: ubuntu-latest
11+
12+
permissions:
13+
contents: write
14+
pull-requests: write
15+
16+
steps:
17+
- name: Release 📦
18+
uses: googleapis/release-please-action@v4
19+
with:
20+
release-type: simple

‎.github/workflows/spelling.yaml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Spelling
2+
3+
permissions:
4+
contents: read
5+
6+
on: [pull_request]
7+
8+
env:
9+
CLICOLOR: 1
10+
11+
jobs:
12+
spelling:
13+
name: Spell Check with Typos
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout 🛎️
17+
uses: actions/checkout@v4
18+
19+
- name: Spell Check 📝
20+
uses: crate-ci/[email protected]
21+

‎.github/workflows/sponsors.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Update Sponsors
2+
3+
on:
4+
workflow_dispatch:
5+
schedule:
6+
- cron: 0 21 * * *
7+
8+
jobs:
9+
deploy:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout 🛎️
13+
uses: actions/checkout@v4
14+
15+
- name: Generate Sponsors 💖
16+
uses: JamesIves/github-sponsors-readme-action@v1
17+
with:
18+
token: ${{ secrets.SPONSORS_TOKEN }}
19+
file: "README.md"
20+
active-only: true
21+
if: ${{ github.repository == 'olimorris/codecompanion.nvim' }}
22+
23+
- name: Create Pull Request 🚀
24+
uses: peter-evans/create-pull-request@v6
25+
with:
26+
commit-message: "docs: update sponsors in README.md"
27+
title: "docs: update sponsors in README.md"
28+
labels: "ignore-for-release"
29+
delete-branch: true

‎.github/workflows/stale.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Update stale Issues and PRs
2+
3+
on:
4+
workflow_dispatch:
5+
schedule:
6+
- cron: 0 13 * * 1-5
7+
8+
jobs:
9+
stale:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/stale@v9
13+
with:
14+
exempt-issue-labels: P1,P2,P3,P4
15+
days-before-stale: 30
16+
days-before-close: 3
17+
# never stale pull requests
18+
days-before-pr-close: -1
19+
# messages
20+
stale-issue-message: 'This issue is stale because it has been open for 30 days with no activity. Remove the stale label or comment or this will be closed in 3 days.'
21+
stale-pr-message: 'This PR is stale because it has been open for 30 days with no activity.'
22+
close-issue-message: 'This issue was closed because it was stalled for 3 days with no activity.'

0 commit comments

Comments
 (0)