Skip to content

Commit cb4e7db

Browse files
vveerrggvveerrgg
committed
Add community files and GitHub templates
1 parent e26dc99 commit cb4e7db

File tree

12 files changed

+430
-0
lines changed

12 files changed

+430
-0
lines changed

‎.github/FUNDING.yml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# These are supported funding model platforms
2+
3+
github: [humanjavaenterprises] # Replace with up to 4 GitHub Sponsors-enabled usernames
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+
custom: [
13+
'https://getalby.com/p/vveerrgg', # Lightning address
14+
'https://blockchair.com/bitcoin/address/bc1qw6kasfudkd64sts2q5a0lpm8zgea9txjc4gxj7', # Bitcoin address
15+
'https://blockchair.com/litecoin/address/ltc1qhvt82z3308nr2gmpfuhldmu9cw3d943n7lf2we' # Litecoin address
16+
] # Up to 4 custom sponsorship URLs

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Configure node with '...'
16+
2. Connect to relay '....'
17+
3. Send message '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Environment (please complete the following information):**
27+
- OS: [e.g. Ubuntu 20.04]
28+
- Node-RED Version: [e.g. 3.0.0]
29+
- Node Version: [e.g. 16.0.0]
30+
- Package Version: [e.g. 0.1.0]
31+
32+
**Additional context**
33+
Add any other context about the problem here.
34+
35+
**Logs**
36+
```
37+
Paste any relevant logs here
38+
```

‎.github/ISSUE_TEMPLATE/code-of-conduct-violation.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Code of Conduct Violation
3+
about: Report a violation of our Code of Conduct
4+
title: '[CODE OF CONDUCT] '
5+
labels: 'code of conduct'
6+
assignees: ''
7+
8+
---
9+
10+
**IMPORTANT**: This issue will be handled with strict confidentiality.
11+
12+
## Description
13+
14+
Please provide a clear description of what occurred, including:
15+
- What happened
16+
- When it happened (date/time)
17+
- Where it happened (GitHub issue, PR, Discussion, etc.)
18+
- Links to any relevant public content (if applicable)
19+
20+
## Additional Context
21+
22+
Any additional context that you feel is important to share.
23+
24+
## Contact Information
25+
26+
How would you prefer to be contacted about this report? (Optional)

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Node-RED Flow Example**
20+
If applicable, describe how you envision this feature being used in a Node-RED flow.
21+
22+
**Additional context**
23+
Add any other context or screenshots about the feature request here.
24+
25+
**Related NIPs**
26+
If this feature is related to specific Nostr Implementation Possibilities (NIPs), please list them here.

‎.github/ISSUE_TEMPLATE/security_vulnerability.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Security Vulnerability
3+
about: Report a security vulnerability
4+
title: '[SECURITY] '
5+
labels: security
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the vulnerability**
11+
A clear and concise description of what the vulnerability is.
12+
13+
**Impact**
14+
Describe the potential impact of this vulnerability if exploited.
15+
16+
**Steps To Reproduce**
17+
1. Configure node with '...'
18+
2. Connect to relay '...'
19+
3. Send payload '...'
20+
4. See vulnerability
21+
22+
**Proof of Concept**
23+
If applicable, provide a proof of concept that demonstrates the vulnerability.
24+
25+
**Suggested Fix**
26+
If you have ideas about how to fix this vulnerability, please share them.
27+
28+
**Environment:**
29+
- OS: [e.g. Ubuntu 20.04]
30+
- Node-RED Version: [e.g. 3.0.0]
31+
- Node Version: [e.g. 16.0.0]
32+
- Package Version: [e.g. 0.1.0]
33+
34+
**Additional context**
35+
Add any other context about the vulnerability here.

‎.github/PULL_REQUEST_TEMPLATE/pull_request_template.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## Description
2+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
3+
4+
Fixes # (issue)
5+
6+
## Type of change
7+
Please delete options that are not relevant.
8+
9+
- [ ] Bug fix (non-breaking change which fixes an issue)
10+
- [ ] New feature (non-breaking change which adds functionality)
11+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
12+
- [ ] Documentation update
13+
14+
## How Has This Been Tested?
15+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.
16+
17+
- [ ] Test A
18+
- [ ] Test B
19+
20+
## Checklist:
21+
Before submitting your PR, please review the following checklist:
22+
23+
- [ ] I have performed a self-review of my own code
24+
- [ ] I have commented my code, particularly in hard-to-understand areas
25+
- [ ] I have made corresponding changes to the documentation
26+
- [ ] My changes generate no new warnings
27+
- [ ] I have added tests that prove my fix is effective or that my feature works
28+
- [ ] New and existing unit tests pass locally with my changes
29+
- [ ] Any dependent changes have been merged and published in downstream modules
30+
31+
## Additional Notes
32+
Add any other context about the pull request here.

‎.github/pull_request_template.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## Description
2+
Please include a summary of the changes and which issue is fixed. Please also include relevant motivation and context.
3+
4+
Fixes # (issue)
5+
6+
## Type of change
7+
Please delete options that are not relevant.
8+
9+
- [ ] Bug fix (non-breaking change which fixes an issue)
10+
- [ ] New feature (non-breaking change which adds functionality)
11+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
12+
- [ ] Documentation update
13+
14+
## How Has This Been Tested?
15+
Please describe the tests that you ran to verify your changes.
16+
17+
- [ ] Test A
18+
- [ ] Test B
19+
20+
## Checklist:
21+
- [ ] My code follows the style guidelines of this project
22+
- [ ] I have performed a self-review of my code
23+
- [ ] I have commented my code, particularly in hard-to-understand areas
24+
- [ ] I have made corresponding changes to the documentation
25+
- [ ] My changes generate no new warnings
26+
- [ ] I have added tests that prove my fix is effective or that my feature works
27+
- [ ] New and existing unit tests pass locally with my changes

‎.github/workflows/ci.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
strategy:
13+
matrix:
14+
node-version: [16.x, 18.x, 20.x]
15+
16+
steps:
17+
- uses: actions/checkout@v3
18+
- name: Use Node.js ${{ matrix.node-version }}
19+
uses: actions/setup-node@v3
20+
with:
21+
node-version: ${{ matrix.node-version }}
22+
cache: 'npm'
23+
- run: npm ci
24+
- run: npm run build
25+
- run: npm test
26+
27+
security:
28+
runs-on: ubuntu-latest
29+
steps:
30+
- uses: actions/checkout@v3
31+
- uses: actions/setup-node@v3
32+
with:
33+
node-version: 18
34+
cache: 'npm'
35+
- run: npm audit

‎.github/workflows/documentation.yml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Documentation
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v3
15+
16+
- name: Use Node.js
17+
uses: actions/setup-node@v3
18+
with:
19+
node-version: '18.x'
20+
cache: 'npm'
21+
22+
- name: Install dependencies
23+
run: npm ci
24+
25+
- name: Generate documentation
26+
run: npm run docs
27+
28+
- name: Deploy to GitHub Pages
29+
if: github.ref == 'refs/heads/main'
30+
uses: peaceiris/actions-gh-pages@v3
31+
with:
32+
github_token: ${{ secrets.GITHUB_TOKEN }}
33+
publish_dir: ./docs
34+
force_orphan: true
35+
user_name: 'github-actions[bot]'
36+
user_email: 'github-actions[bot]@users.noreply.github.com'
37+
commit_message: 'docs: update documentation'

‎.github/workflows/publish.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Publish Package
2+
3+
on:
4+
release:
5+
types: [created]
6+
7+
jobs:
8+
build:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v3
12+
- uses: actions/setup-node@v3
13+
with:
14+
node-version: '18.x'
15+
registry-url: 'https://registry.npmjs.org'
16+
- run: npm ci
17+
- run: npm test
18+
- run: npm run build
19+
- run: npm publish --access public
20+
env:
21+
NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}

0 commit comments

Comments
 (0)