Skip to content

Commit

Permalink
ci: add github workflows and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dev-ahmadbilal committed Aug 30, 2024
1 parent 7c7c300 commit 3c4669c
Show file tree
Hide file tree
Showing 7 changed files with 149 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: "🐛 Bug Report"
about: Report a reproducible bug or regression.
title: 'Bug title here'
labels: bug
assignees: 'Your GitHub username here'

---

## Current Behavior

<!-- Describe how the issue manifests. -->
Currently, [describe the specific issue that is occurring], and it leads to [describe any negative impact, such as errors or unwanted behavior].

## Expected Behavior

<!-- Describe what the desired behavior would be. -->
The expected behavior is [describe what should happen instead], and it should [mention how this fixes the issue].

## Steps to Reproduce the Problem

1. [First step to reproduce the issue]
2. [Second step]
3. [Third step]
4. [Add more steps as necessary]

## Environment

- Version: <!-- Version set in package.json -->
- Example: v1.2.3
- Platform: <!-- Win/Mac/Linux -->
- Example: macOS 12.5
- Node.js Version: <!-- Output of running `node -v` -->
- Example: v18.19.1
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: 🌈 Feature request
about: Suggest an amazing new idea for this project
title: 'Add your feature title here'
labels: enhancement
assignees: 'Your GitHub username here'

---

## Feature Request

**Is your feature request related to a problem? Please describe.**
<!-- A clear and concise description of what the problem is. Ex: I have an issue when [...] -->
Currently, there is no way to [describe the issue or challenge], and this is causing [describe any impact or inconvenience caused by the issue].

**Describe the solution you'd like**
<!-- A clear and concise description of what you want to happen. Add any considered drawbacks. -->
The solution should [briefly describe the feature you are proposing], which will help [explain the impact or improvement]. It should ideally [mention any specific behavior or functionality expected].

**Describe alternatives you've considered**
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
I have considered [mention any alternative solutions], but they [explain why those solutions are not ideal or why your suggested solution is better].

## Are you willing to resolve this issue by submitting a Pull Request?

<!--
Remember that first-time contributors are welcome! 🙌
-->

- [ ] Yes, I have the time, and I know how to start.
- [ ] Yes, I have the time, but I don't know how to start. I would need guidance.
- [ ] No, I don't have the time, although I believe I could do it if I had the time...
- [ ] No, I don't have the time and I wouldn't even know how to start.

<!--
👋 Have a great day and thank you for the feature request!
-->
29 changes: 29 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## Description of Changes

This PR introduces [describe feature or fix]. It addresses [issue] by [briefly describe the fix or feature]. The current behavior is [describe the problem], and the new behavior is [describe the solution or improvement].

## Related Issues

Fixes #0000.

## How Has This Been Tested?

This change has been tested by:
1. Running `npm run test` to ensure all unit tests pass.
2. Performing manual testing in [testing environment] to verify the behavior.
3. [If applicable] Running integration tests to ensure no regressions were introduced.

## Screenshots or Demonstrations

[Include screenshots or video links here, if necessary.]

## Pull Request Checklist

- [ ] The code is up-to-date with the `main` branch
- [ ] I have performed a self-review of my code
- [ ] `npm run lint` passes with this change
- [ ] `npm run test` passes with this change
- [ ] Tests have been added/updated for new functionality
- [ ] Documentation has been updated to reflect this change (if applicable)
- [ ] The commits follow the [conventional commit spec](https://www.conventionalcommits.org/en/v1.0.0/)
- [ ] This pull request links relevant issues as `Fixes #0000`
9 changes: 9 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
version: 2
updates:
- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "daily"
target-branch: "main"
labels:
- "dependencies"
19 changes: 19 additions & 0 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: "CodeQL"

permissions:
security-events: write
actions: read
contents: read

on:
push:
branches: [main]
pull_request:
# The branches below must be a subset of the branches above
branches: [main]
schedule:
- cron: "36 7 * * 6"

jobs:
analyze:
uses: dev-ahmadbilal/reuseble-workflows/.github/workflows/codeql-analysis.yml@main
7 changes: 7 additions & 0 deletions .github/workflows/pr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
name: Pull Request

on: [pull_request]

jobs:
build:
uses: dev-ahmadbilal/reuseble-workflows/.github/workflows/pr.yml@main
14 changes: 14 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Release
on:
push:
branches:
- main
jobs:
release:
permissions:
contents: write
issues: write
pull-requests: write
uses: dev-ahmadbilal/reuseble-workflows/.github/workflows/release.yml@main
secrets:
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

0 comments on commit 3c4669c

Please sign in to comment.