Skip to content

Commit 5fc0d18

Browse files
giladgdgiladgd
authored
feat: make contributions and support more efficient via GitHub templates (#28)
1 parent 7837af7 commit 5fc0d18

File tree

8 files changed

+272
-1
lines changed

8 files changed

+272
-1
lines changed

‎.github/FUNDING.yml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# These are supported funding model platforms
2+
3+
github: [giladgd, ido-pluto]
4+
patreon: # Replace with a single Patreon username
5+
open_collective: # Replace with a single Open Collective username
6+
ko_fi: # Replace with a single Ko-fi username
7+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
liberapay: # Replace with a single Liberapay username
10+
issuehunt: # Replace with a single IssueHunt username
11+
otechie: # Replace with a single Otechie username
12+
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
13+
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
name: 🐛 Bug Report
2+
description: Report a reproducible bug
3+
labels:
4+
- requires triage
5+
- bug
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |-
10+
Have a question? This is the `node-llama-cpp` issue tracker – and is not the right place for general support or questions.
11+
Instead, use [`node-llama-cpp` GitHub Discussions](https://github.com/withcatai/node-llama-cpp/discussions) to get support or ask questions.
12+
- type: input
13+
id: description
14+
attributes:
15+
label: Issue description
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: expected
20+
attributes:
21+
label: Expected Behavior
22+
description: "A clear and concise description of what you expected to happen."
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: actual
27+
attributes:
28+
label: Actual Behavior
29+
description: >-
30+
A clear and concise description of what actually happened. Please wrap
31+
any error messages or output in code tags, instead of images.
32+
validations:
33+
required: true
34+
- type: textarea
35+
id: steps
36+
attributes:
37+
label: Steps to reproduce
38+
description: >-
39+
Your bug can be investigated much faster if your code can be run without any dependencies other than `node-llama-cpp`.
40+
Issues without reproduction steps or code examples may be closed as not actionable.
41+
Please try to provide a Minimal, Complete, and Verifiable example ([link](http://stackoverflow.com/help/mcve)).
42+
placeholder: >-
43+
Please try to provide a Minimal, Complete, and Verifiable example.
44+
http://stackoverflow.com/help/mcve
45+
validations:
46+
required: true
47+
- type: textarea
48+
id: env
49+
attributes:
50+
label: My Environment
51+
description: >-
52+
Please add any other relevant dependencies to this table at the end.
53+
For example: Electron, Bun, Webpack.
54+
value: |
55+
| Dependency | Version |
56+
| --- | --- |
57+
| Operating System | |
58+
| Node.js version | x.y.zzz |
59+
| Typescript version | x.y.zzz |
60+
| `node-llama-cpp` version | x.y.zzz |
61+
validations:
62+
required: true
63+
- type: textarea
64+
id: context
65+
attributes:
66+
label: Additional Context
67+
description: >-
68+
Add any other context about the bug report here.
69+
- type: checkboxes
70+
id: drivers
71+
attributes:
72+
label: Relevant Features Used
73+
options:
74+
- label: Metal support
75+
required: false
76+
- label: CUDA support
77+
required: false
78+
- label: Grammar
79+
required: false
80+
- type: dropdown
81+
id: pr
82+
attributes:
83+
label: Are you willing to resolve this issue by submitting a Pull Request?
84+
options:
85+
- Yes, I have the time, and I know how to start.
86+
- >-
87+
Yes, I have the time, but I don't know how to start. I would need
88+
guidance.
89+
- >-
90+
No, I don’t have the time, but I can support (using donations)
91+
development.
92+
- >-
93+
No, I don’t have the time and I’m okay to wait for the community /
94+
maintainers to resolve this issue.
95+
validations:
96+
required: true
97+
- type: markdown
98+
attributes:
99+
value: |-
100+
First-time contributors are always welcome! 🙌
101+
102+
👋 Have a great day and thank you for the bug report!

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
contact_links:
2+
- name: 🤔 Questions, General Support, and Help
3+
url: https://github.com/withcatai/node-llama-cpp/discussions
4+
about: This issue tracker is not for support questions. Please use GitHub discussions instead.

‎.github/ISSUE_TEMPLATE/documentation-issue.yml‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: 📝 Documentation Issue
2+
description: Documentation is unclear or otherwise insufficient.
3+
labels:
4+
- requires triage
5+
- documentation
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >-
10+
Have a question? This is the `node-llama-cpp` issue tracker – and is not the right place for general support or questions.
11+
Instead, use [`node-llama-cpp` GitHub Discussions](https://github.com/withcatai/node-llama-cpp/discussions) to get support or ask questions.
12+
- type: textarea
13+
id: details
14+
attributes:
15+
label: What was unclear or otherwise insufficient?
16+
description: >-
17+
If relevant, please be clear about the documentation URL, as well as the location within the page.
18+
Add a link to the relevant documentation you're referring to.
19+
placeholder: >-
20+
If the page or section does not exist, please be clear why a new documentation page or section is needed.
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: recommendation
25+
attributes:
26+
label: Recommended Fix
27+
description: How should this documentation issue be fixed?
28+
placeholder: Should there be more examples, the language be clarified, or the section be dropped entirely?
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: context
33+
attributes:
34+
label: Additional Context
35+
description: Add any other context about the documentation issue here.
36+
- type: dropdown
37+
id: pr
38+
attributes:
39+
label: Are you willing to resolve this issue by submitting a Pull Request?
40+
options:
41+
- Yes, I have the time, and I know how to start.
42+
- >-
43+
Yes, I have the time, but I don't know how to start. I would need
44+
guidance.
45+
- >-
46+
No, I don’t have the time, but I can support (using donations)
47+
development.
48+
- >-
49+
No, I don’t have the time and I’m okay to wait for the community /
50+
maintainers to resolve this issue.
51+
validations:
52+
required: true
53+
- type: markdown
54+
attributes:
55+
value: |-
56+
First-time contributors are always welcome! 🙌
57+
58+
👋 Have a great day and thank you for the documentation issue!

‎.github/ISSUE_TEMPLATE/feature-request.yml‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
name: ✨ Feature request
2+
description: Suggest an new idea for this project
3+
labels:
4+
- requires triage
5+
- new feature
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >-
10+
Have a question? This is the `node-llama-cpp` issue tracker – and is not the right place for general support or questions.
11+
Instead, use [`node-llama-cpp` GitHub Discussions](https://github.com/withcatai/node-llama-cpp/discussions) to get support or ask questions.
12+
- type: textarea
13+
id: problem
14+
attributes:
15+
label: Feature Description
16+
description: >-
17+
A clear and concise description of what the problem is,
18+
and why it needs to be implemented as a new feature in `node-llama-cpp`.
19+
placeholder: For example, "I'm frustrated when ..."
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: solution
24+
attributes:
25+
label: The Solution
26+
description: A clear and concise description of what you want to happen.
27+
placeholder: >-
28+
How can the requested feature be used to approach the problem it's supposed to solve?
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: alt
33+
attributes:
34+
label: Considered Alternatives
35+
description: >-
36+
A clear and concise description of any alternative solutions or features you've considered.
37+
placeholder: If any workaround exists to the best of your knowledge, include it here.
38+
validations:
39+
required: true
40+
- type: textarea
41+
id: context
42+
attributes:
43+
label: Additional Context
44+
description: Add any other context about the feature request here
45+
- type: checkboxes
46+
id: drivers
47+
attributes:
48+
label: Related Features to This Feature Request
49+
options:
50+
- label: Metal support
51+
required: false
52+
- label: CUDA support
53+
required: false
54+
- label: Grammar
55+
required: false
56+
- type: dropdown
57+
id: pr
58+
attributes:
59+
label: Are you willing to resolve this issue by submitting a Pull Request?
60+
options:
61+
- Yes, I have the time, and I know how to start.
62+
- >-
63+
Yes, I have the time, but I don't know how to start. I would need
64+
guidance.
65+
- >-
66+
No, I don’t have the time, but I can support (using donations)
67+
development.
68+
- >-
69+
No, I don’t have the time and I’m okay to wait for the community /
70+
maintainers to resolve this issue.
71+
validations:
72+
required: true
73+
- type: markdown
74+
attributes:
75+
value: |-
76+
First-time contributors are always welcome! 🙌
77+
78+
👋 Have a great day and thank you for the feature request!

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,4 @@
2929
- [ ] This pull request links relevant issues as `Fixes #0000`
3030
- [ ] There are new or updated unit tests validating the change
3131
- [ ] Documentation has been updated to reflect this change
32-
- [ ] The new commits follow conventions explained in [CONTRIBUTING.md](https://github.com/withcatai/node-llama-cpp/blob/master/CONTRIBUTING.md)
32+
- [ ] The new commits and pull request title follow conventions explained in [CONTRIBUTING.md](https://github.com/withcatai/node-llama-cpp/blob/master/CONTRIBUTING.md) (PRs that do not follow this convention will not be merged)

‎.github/workflows/prLint.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: PR Lint
2+
on:
3+
pull_request:
4+
pull_request_target:
5+
types: [opened, reopened, edited, synchronize]
6+
jobs:
7+
lint:
8+
name: Lint
9+
runs-on: ubuntu-latest
10+
permissions:
11+
pull-requests: read
12+
steps:
13+
- uses: amannn/action-semantic-pull-request@v5
14+
env:
15+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/test.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ name: Test
22
on: [push]
33
jobs:
44
test:
5+
name: Test
56
runs-on: ubuntu-latest
67
steps:
78
- uses: actions/checkout@v3

0 commit comments

Comments
 (0)