Skip to content

Commit 6858e42

Browse files
xarlizardxarlizard
authored
Merge pull request #2 from xarlizard/dev
Merge dev into main
2 parents 8868617 + 3781500 commit 6858e42

File tree

11 files changed

+449
-8
lines changed

11 files changed

+449
-8
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
name: Bug Report
2+
description: Report a bug in the npm package template
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report! 🐛
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Bug Description
15+
description: A clear and concise description of what the bug is.
16+
placeholder: Describe the bug...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: reproduction
22+
attributes:
23+
label: Steps to Reproduce
24+
description: Steps to reproduce the behavior
25+
placeholder: |
26+
1. Go to '...'
27+
2. Click on '...'
28+
3. Scroll down to '...'
29+
4. See error
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: expected
35+
attributes:
36+
label: Expected Behavior
37+
description: What you expected to happen
38+
placeholder: Describe what you expected to happen...
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: actual
44+
attributes:
45+
label: Actual Behavior
46+
description: What actually happened
47+
placeholder: Describe what actually happened...
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: environment
53+
attributes:
54+
label: Environment
55+
description: Please provide your environment details
56+
placeholder: |
57+
- OS: [e.g. Windows 11, macOS 12.3, Ubuntu 20.04]
58+
- Node.js version: [e.g. 18.15.0]
59+
- npm version: [e.g. 9.5.0]
60+
- Package version: [e.g. 1.0.0]
61+
validations:
62+
required: true
63+
64+
- type: textarea
65+
id: additional
66+
attributes:
67+
label: Additional Context
68+
description: Add any other context about the problem here
69+
placeholder: Add any screenshots, logs, or additional information...
70+
71+
- type: checkboxes
72+
id: terms
73+
attributes:
74+
label: Checklist
75+
description: Please confirm the following
76+
options:
77+
- label: I have searched existing issues to avoid duplicates
78+
required: true
79+
- label: I have provided all required information
80+
required: true
81+
- label: I have tested this with the latest version
82+
required: true

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
name: Documentation Issue
2+
description: Report an issue with documentation
3+
title: "[Docs]: "
4+
labels: ["documentation", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping improve our documentation! 📚
10+
11+
- type: dropdown
12+
id: doc-type
13+
attributes:
14+
label: Documentation Type
15+
description: What type of documentation issue is this?
16+
options:
17+
- README.md
18+
- Setup Guide (TEMPLATE_SETUP.md)
19+
- API Documentation
20+
- Examples
21+
- Contributing Guide
22+
- Code Comments
23+
- Other
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: issue
29+
attributes:
30+
label: Documentation Issue
31+
description: What's wrong with the current documentation?
32+
placeholder: Describe the documentation issue...
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: location
38+
attributes:
39+
label: Location
40+
description: Where is this documentation located?
41+
placeholder: |
42+
- File: README.md
43+
- Section: Installation
44+
- Line: 45
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: suggestion
50+
attributes:
51+
label: Suggested Improvement
52+
description: How would you improve this documentation?
53+
placeholder: Describe your suggested improvement...
54+
validations:
55+
required: true
56+
57+
- type: textarea
58+
id: additional
59+
attributes:
60+
label: Additional Context
61+
description: Any additional context or examples
62+
placeholder: Add any additional context...
63+
64+
- type: checkboxes
65+
id: terms
66+
attributes:
67+
label: Checklist
68+
description: Please confirm the following
69+
options:
70+
- label: I have searched existing issues to avoid duplicates
71+
required: true
72+
- label: I have provided specific details about the issue
73+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
name: Feature Request
2+
description: Suggest a new feature for the npm package template
3+
title: "[Feature]: "
4+
labels: ["enhancement", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a new feature! 🚀
10+
11+
- type: textarea
12+
id: summary
13+
attributes:
14+
label: Feature Summary
15+
description: A brief summary of the feature you'd like to see
16+
placeholder: Briefly describe the feature...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: motivation
22+
attributes:
23+
label: Motivation
24+
description: Why would this feature be useful? What problem does it solve?
25+
placeholder: Explain the motivation and use case...
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: solution
31+
attributes:
32+
label: Proposed Solution
33+
description: How would you like this feature to work?
34+
placeholder: Describe your proposed solution...
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: alternatives
40+
attributes:
41+
label: Alternative Solutions
42+
description: Are there any alternative solutions or workarounds?
43+
placeholder: Describe any alternative solutions you've considered...
44+
45+
- type: textarea
46+
id: examples
47+
attributes:
48+
label: Examples
49+
description: Provide examples of how this feature would be used
50+
placeholder: |
51+
```typescript
52+
// Example usage
53+
```
54+
55+
- type: dropdown
56+
id: priority
57+
attributes:
58+
label: Priority
59+
description: How important is this feature to you?
60+
options:
61+
- Low - Nice to have
62+
- Medium - Would be helpful
63+
- High - Important for my use case
64+
- Critical - Blocking my usage
65+
validations:
66+
required: true
67+
68+
- type: checkboxes
69+
id: contribution
70+
attributes:
71+
label: Contribution
72+
description: Are you willing to contribute to this feature?
73+
options:
74+
- label: I'm willing to submit a pull request for this feature
75+
- label: I can help with testing
76+
- label: I can help with documentation
77+
78+
- type: checkboxes
79+
id: terms
80+
attributes:
81+
label: Checklist
82+
description: Please confirm the following
83+
options:
84+
- label: I have searched existing issues to avoid duplicates
85+
required: true
86+
- label: This feature would benefit the broader community
87+
required: true
88+
- label: I have provided sufficient detail for evaluation
89+
required: true

‎.github/dependabot.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
version: 2
2+
updates:
3+
# Enable version updates for npm
4+
- package-ecosystem: "npm"
5+
directory: "/"
6+
schedule:
7+
interval: "daily"
8+
reviewers:
9+
- "xarlizard"
10+
assignees:
11+
- "xarlizard"
12+
commit-message:
13+
prefix: "chore"
14+
include: "scope"
15+
# Allow both direct and indirect dependencies
16+
allow:
17+
- dependency-type: "direct"
18+
- dependency-type: "indirect"
19+
# Ignore major version updates for stability
20+
ignore:
21+
- dependency-name: "*"
22+
update-types: ["version-update:semver-major"]
23+
24+
# Enable version updates for GitHub Actions
25+
- package-ecosystem: "github-actions"
26+
directory: "/"
27+
schedule:
28+
interval: "weekly"
29+
reviewers:
30+
- "xarlizard"
31+
assignees:
32+
- "xarlizard"
33+
commit-message:
34+
prefix: "ci"
35+
include: "scope"

‎.github/pull_request_template.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
## Description
2+
3+
<!-- Provide a brief description of the changes in this PR -->
4+
5+
## Type of Change
6+
7+
<!-- Mark the relevant option with an "x" -->
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+
- [ ] 🔧 Maintenance (refactoring, dependencies, etc.)
14+
15+
## Changes Made
16+
17+
<!-- List the specific changes made in this PR -->
18+
19+
-
20+
-
21+
-
22+
23+
## Testing
24+
25+
<!-- Describe how you tested these changes -->
26+
27+
- [ ] All existing tests pass
28+
- [ ] New tests have been added for new functionality
29+
- [ ] Manual testing has been performed
30+
- [ ] Example code has been tested
31+
32+
## Checklist
33+
34+
<!-- Mark completed items with an "x" -->
35+
36+
- [ ] My code follows the project's style guidelines
37+
- [ ] I have performed a self-review of my own code
38+
- [ ] I have commented my code, particularly in hard-to-understand areas
39+
- [ ] I have made corresponding changes to the documentation
40+
- [ ] My changes generate no new warnings
41+
- [ ] I have added tests that prove my fix is effective or that my feature works
42+
- [ ] New and existing unit tests pass locally with my changes
43+
- [ ] Any dependent changes have been merged and published
44+
45+
## Related Issues
46+
47+
<!-- Link any related issues using "Closes #123" or "Fixes #123" -->
48+
49+
Closes #
50+
51+
## Screenshots (if applicable)
52+
53+
<!-- Add screenshots to help explain your changes -->
54+
55+
## Additional Notes
56+
57+
<!-- Add any additional notes, considerations, or context -->
58+
59+
## Deployment Notes
60+
61+
<!-- Any special considerations for deployment -->
62+
63+
---
64+
65+
**For Template Users:**
66+
If you're using this template, please update this section with your specific PR template requirements.
67+
68+
**For Maintainers:**
69+
- [ ] Code review completed
70+
- [ ] All CI checks pass
71+
- [ ] Documentation updated
72+
- [ ] Ready to merge

‎.github/workflows/deploy.yml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Deploy
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
deploy:
10+
runs-on: ubuntu-latest
11+
environment:
12+
name: production
13+
url: https://www.npmjs.com/package/react-api-forge
14+
15+
steps:
16+
- uses: actions/checkout@v3
17+
18+
- name: Build and Deploy
19+
run: echo "This is a template. Add your deployment command here, e.g., npm run deploy, scp, rsync, or a cloud CLI."

0 commit comments

Comments
 (0)