Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 82 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
name: Bug Report
description: Report a bug in the npm package template
title: "[Bug]: "
labels: ["bug", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report! 🐛

- type: textarea
id: description
attributes:
label: Bug Description
description: A clear and concise description of what the bug is.
placeholder: Describe the bug...
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Steps to Reproduce
description: Steps to reproduce the behavior
placeholder: |
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected Behavior
description: What you expected to happen
placeholder: Describe what you expected to happen...
validations:
required: true

- type: textarea
id: actual
attributes:
label: Actual Behavior
description: What actually happened
placeholder: Describe what actually happened...
validations:
required: true

- type: textarea
id: environment
attributes:
label: Environment
description: Please provide your environment details
placeholder: |
- OS: [e.g. Windows 11, macOS 12.3, Ubuntu 20.04]
- Node.js version: [e.g. 18.15.0]
- npm version: [e.g. 9.5.0]
- Package version: [e.g. 1.0.0]
validations:
required: true

- type: textarea
id: additional
attributes:
label: Additional Context
description: Add any other context about the problem here
placeholder: Add any screenshots, logs, or additional information...

- type: checkboxes
id: terms
attributes:
label: Checklist
description: Please confirm the following
options:
- label: I have searched existing issues to avoid duplicates
required: true
- label: I have provided all required information
required: true
- label: I have tested this with the latest version
required: true
73 changes: 73 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
name: Documentation Issue
description: Report an issue with documentation
title: "[Docs]: "
labels: ["documentation", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for helping improve our documentation! 📚

- type: dropdown
id: doc-type
attributes:
label: Documentation Type
description: What type of documentation issue is this?
options:
- README.md
- Setup Guide (TEMPLATE_SETUP.md)
- API Documentation
- Examples
- Contributing Guide
- Code Comments
- Other
validations:
required: true

- type: textarea
id: issue
attributes:
label: Documentation Issue
description: What's wrong with the current documentation?
placeholder: Describe the documentation issue...
validations:
required: true

- type: textarea
id: location
attributes:
label: Location
description: Where is this documentation located?
placeholder: |
- File: README.md
- Section: Installation
- Line: 45
validations:
required: true

- type: textarea
id: suggestion
attributes:
label: Suggested Improvement
description: How would you improve this documentation?
placeholder: Describe your suggested improvement...
validations:
required: true

- type: textarea
id: additional
attributes:
label: Additional Context
description: Any additional context or examples
placeholder: Add any additional context...

- type: checkboxes
id: terms
attributes:
label: Checklist
description: Please confirm the following
options:
- label: I have searched existing issues to avoid duplicates
required: true
- label: I have provided specific details about the issue
required: true
89 changes: 89 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
name: Feature Request
description: Suggest a new feature for the npm package template
title: "[Feature]: "
labels: ["enhancement", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for suggesting a new feature! 🚀

- type: textarea
id: summary
attributes:
label: Feature Summary
description: A brief summary of the feature you'd like to see
placeholder: Briefly describe the feature...
validations:
required: true

- type: textarea
id: motivation
attributes:
label: Motivation
description: Why would this feature be useful? What problem does it solve?
placeholder: Explain the motivation and use case...
validations:
required: true

- type: textarea
id: solution
attributes:
label: Proposed Solution
description: How would you like this feature to work?
placeholder: Describe your proposed solution...
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternative Solutions
description: Are there any alternative solutions or workarounds?
placeholder: Describe any alternative solutions you've considered...

- type: textarea
id: examples
attributes:
label: Examples
description: Provide examples of how this feature would be used
placeholder: |
```typescript
// Example usage
```

- type: dropdown
id: priority
attributes:
label: Priority
description: How important is this feature to you?
options:
- Low - Nice to have
- Medium - Would be helpful
- High - Important for my use case
- Critical - Blocking my usage
validations:
required: true

- type: checkboxes
id: contribution
attributes:
label: Contribution
description: Are you willing to contribute to this feature?
options:
- label: I'm willing to submit a pull request for this feature
- label: I can help with testing
- label: I can help with documentation

- type: checkboxes
id: terms
attributes:
label: Checklist
description: Please confirm the following
options:
- label: I have searched existing issues to avoid duplicates
required: true
- label: This feature would benefit the broader community
required: true
- label: I have provided sufficient detail for evaluation
required: true
35 changes: 35 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
version: 2
updates:
# Enable version updates for npm
- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "daily"
reviewers:
- "xarlizard"
assignees:
- "xarlizard"
commit-message:
prefix: "chore"
include: "scope"
# Allow both direct and indirect dependencies
allow:
- dependency-type: "direct"
- dependency-type: "indirect"
# Ignore major version updates for stability
ignore:
- dependency-name: "*"
update-types: ["version-update:semver-major"]

# Enable version updates for GitHub Actions
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
reviewers:
- "xarlizard"
assignees:
- "xarlizard"
commit-message:
prefix: "ci"
include: "scope"
72 changes: 72 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
## Description

<!-- Provide a brief description of the changes in this PR -->

## Type of Change

<!-- Mark the relevant option with an "x" -->

- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
- [ ] 🚀 New feature (non-breaking change which adds functionality)
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] 📚 Documentation update
- [ ] 🔧 Maintenance (refactoring, dependencies, etc.)

## Changes Made

<!-- List the specific changes made in this PR -->

-
-
-

## Testing

<!-- Describe how you tested these changes -->

- [ ] All existing tests pass
- [ ] New tests have been added for new functionality
- [ ] Manual testing has been performed
- [ ] Example code has been tested

## Checklist

<!-- Mark completed items with an "x" -->

- [ ] My code follows the project's style guidelines
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published

## Related Issues

<!-- Link any related issues using "Closes #123" or "Fixes #123" -->

Closes #

## Screenshots (if applicable)

<!-- Add screenshots to help explain your changes -->

## Additional Notes

<!-- Add any additional notes, considerations, or context -->

## Deployment Notes

<!-- Any special considerations for deployment -->

---

**For Template Users:**
If you're using this template, please update this section with your specific PR template requirements.

**For Maintainers:**
- [ ] Code review completed
- [ ] All CI checks pass
- [ ] Documentation updated
- [ ] Ready to merge
19 changes: 19 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Deploy

on:
push:
branches:
- main

jobs:
deploy:
runs-on: ubuntu-latest
environment:
name: production
url: https://www.npmjs.com/package/react-api-forge

steps:
- uses: actions/checkout@v3

- name: Build and Deploy
run: echo "This is a template. Add your deployment command here, e.g., npm run deploy, scp, rsync, or a cloud CLI."
Loading