Skip to content

Commit a5bcc8b

Browse files
INeedJobToStartWorkINeedJobToStartWork
committed
🚀Init: add boilerplate files!
1 parent 3cdba48 commit a5bcc8b

16 files changed

Lines changed: 8546 additions & 0 deletions

File tree

‎.changeset/README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Changesets
2+
3+
Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works with
4+
multi-package repos, or single-package repos to help you version and publish your code. You can find the full
5+
documentation for it [in our repository](https://github.com/changesets/changesets)
6+
7+
We have a quick list of common questions to get you started engaging with this project in
8+
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

‎.changeset/config.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"$schema": "https://unpkg.com/@changesets/config@3.0.0/schema.json",
3+
"changelog": "@changesets/cli/changelog",
4+
"commit": false,
5+
"fixed": [],
6+
7+
"linked": [],
8+
"access": "public",
9+
"baseBranch": "main",
10+
"updateInternalDependencies": "patch",
11+
"ignore": []
12+
}

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
name: "🐞 Report a bug"
2+
title: "🐞[BUG] - <TITLE_OF_ISSUE>"
3+
description: Create new report!
4+
labels: [bug]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for taking the time to report a bug to BetterNPM repo! 🙏
10+
11+
If you have a question about how to achieve something and are struggling, please post a question
12+
inside of either of the following places:
13+
- BetterNPM's 💬[Discussion's tab](https://github.com/INeedJobToStartWork/BetterNPM/discussions)
14+
15+
Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already:
16+
- BetterNPM's [Issue's tab](https://github.com/INeedJobToStartWork/BetterNPM/issues)
17+
- BetterNPM's [closed issues tab](https://github.com/INeedJobToStartWork/BetterNPM/issues?q=is%3Aissue+is%3Aclosed)
18+
- BetterNPM's [Discussions tab](https://github.com/INeedJobToStartWork/BetterNPM/discussions)
19+
20+
21+
Please fill in as much of the template below as you're able. If you don't know the answer to a question, that's okay, but please try to fill in as much as you can.
22+
It'll help us to triage your issue as quickly as possible.
23+
- type: input
24+
id: description
25+
attributes:
26+
label: Issue Description
27+
description: Please give a short description of the issue
28+
placeholder: Description title
29+
validations:
30+
required: true
31+
- type: input
32+
id: BetterNPM_version
33+
attributes:
34+
label: BetterNPM Version
35+
description: Which BetterNPM version are you using?
36+
placeholder: e.g. v0.5.0
37+
validations:
38+
required: true
39+
- type: checkboxes
40+
id: BetterNPM_latest
41+
attributes:
42+
label: Tested on Latest Version
43+
description: Check if this issue is reproducible with the latest version - it could be fixed.
44+
options:
45+
- label: "Yes"
46+
- type: input
47+
id: reproductionLink
48+
attributes:
49+
label: Reproduction
50+
description: Please provide a link to a reproduction on Github, CodeSandbox or StackBlitz.
51+
placeholder: |
52+
e.g. https://github.com/INeedJobToStartWork/xxx
53+
- type: textarea
54+
id: reproductionProcess
55+
attributes:
56+
label: Process to Reproduce bug
57+
description: Please provide steps to reproduce the bug.
58+
placeholder: |
59+
e.g.
60+
1. Go to '...'
61+
2. Click on '....'
62+
3. Scroll down to '....'
63+
4. See error
64+
- type: textarea
65+
id: reproductionImages
66+
attributes:
67+
label: Photo/Images Showing Bug
68+
description: |
69+
If applicable, please provide screenshots or photos showing the bug.
70+
More about github attachments limits: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files.
71+
- type: textarea
72+
id: reproductionLogs
73+
attributes:
74+
label: Logs
75+
description: If applicable, please provide logs showing the bug (if exists).
76+
- type: textarea
77+
id: expectedBehavior
78+
attributes:
79+
label: What we got - What we expected
80+
description: What did you expect to happen? What happened instead?
81+
- type: textarea
82+
id: additionalContext
83+
attributes:
84+
label: Additional Context
85+
description: What did you wanted to do? Please provide any additional information here.
86+
- type: textarea
87+
id: triedFix
88+
attributes:
89+
label: What did you try to fix it?
90+
description: What did you try to fix it? Every information is useful.
91+
- type: textarea
92+
id: howSolved
93+
attributes:
94+
label: How did you solve it?
95+
description: How did you solve it? It's okay if you didn't solve it yet.
96+
- type: textarea
97+
id: possibleSolution
98+
attributes:
99+
label: How problem can be solved?
100+
description: If you have any idea, please share it with us.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: 🤔 Long question or ideas?
4+
url: https://github.com/INeedJobToStartWork/BetterNPM/discussions
5+
about: Ask long-form questions and discuss ideas.

‎.github/ISSUE_TEMPLATE/feature_request.yaml‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: "✨Idea - Feature Request"
2+
title: "✨[Idea] - <TITLE_OF_ISSUE>"
3+
description: Share your ideas with us!
4+
labels: [feature]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Wow, good to see you there!
10+
It's good to know you're creative ✨
11+
12+
Before submitting a new feature request, please check the links below to see if there somebody already requested it:
13+
- BetterNPM's [Issue's tab](https://github.com/INeedJobToStartWork/BetterNPM/issues)
14+
- BetterNPM's [closed issues tab](https://github.com/INeedJobToStartWork/BetterNPM/issues?q=is%3Aissue+is%3Aclosed)
15+
- BetterNPM's [Discussions tab](https://github.com/INeedJobToStartWork/BetterNPM/discussions)
16+
17+
Please fill in as much of the template below as you're able. If you don't know the answer to a question, that's okay, but please try to fill in as much as you can.
18+
- type: input
19+
id: idea
20+
attributes:
21+
label: Idea ✨
22+
description: Please give a short description of the feature
23+
placeholder: e.g. I want to add cooldown to button
24+
validations:
25+
required: true
26+
27+
- type: input
28+
id: work
29+
attributes:
30+
label: How it should work?
31+
description: Give a description of how it should work
32+
placeholder: |
33+
e.g After clicking button, it should be disabled for X seconds
34+
validations:
35+
required: true
36+
37+
- type: input
38+
id: solution
39+
attributes:
40+
label: What it gonna solve? Why we should ad it?
41+
description: How it will help you and others? What kind of problems it will solve?.
42+
placeholder: |
43+
e.g It will help me and users to prevent api calls spamming and give a better user experience.
44+
validations:
45+
required: true
46+
47+
- type: input
48+
id: implementation
49+
attributes:
50+
label: How it should be implemented?
51+
description: What do you expect, how it should be implemented? Which props?
52+
53+
validations:
54+
required: true
55+
56+
- type: input
57+
id: example
58+
attributes:
59+
label: Example of usage / I have seen it in other library
60+
description: |
61+
You can give a link to currently implemented feature in other library / give your own example.
62+
(Images, videos, code snippets, etc.)
63+
placeholder: |
64+
e.g Similar feature is implemented in XXX lib.
65+
Here is link: XXXX

‎.github/common-actions/install/action.yaml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: 'install'
2+
description: 'Sets up Node.js and runs install'
3+
4+
runs:
5+
using: 'composite'
6+
steps:
7+
- name: 🚀 Setup pnpm
8+
uses: pnpm/action-setup@v4
9+
- name: 🟢 Setup node
10+
uses: actions/setup-node@v4.0.2
11+
with:
12+
node-version-file: '.nvmrc'
13+
registry-url: 'https://registry.npmjs.org'
14+
cache: 'pnpm'
15+
16+
- name: 🤖 Setup Git User
17+
shell: bash
18+
run: |
19+
git config --global user.email "ineedjobtostartwork@gmail.com"
20+
git config --global user.name "INEEDJ"
21+
- name: ↘️ Install dependencies
22+
shell: bash
23+
run: pnpm install --no-frozen-lockfile

‎.github/workflows/ci.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: CI/CD
2+
on:
3+
push:
4+
branches: [main]
5+
pull_request:
6+
branches: [main]
7+
jobs:
8+
Deploy:
9+
runs-on: ubuntu-latest
10+
11+
steps:
12+
- uses: actions/checkout@v2
13+
- name: 🟢 Setup
14+
uses: ./.github/common-actions/install
15+
- name: 📝 Lint
16+
run: pnpm lint
17+
- name: ♻️ Format
18+
run: pnpm format
19+
- name: 🏗️ Build Package
20+
run: pnpm build:npm

‎.github/workflows/publish.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Publish Package to npmjs
2+
on:
3+
push:
4+
branches:
5+
- main
6+
7+
concurrency: ${{ github.workflow }}-${{ github.ref }}
8+
9+
jobs:
10+
release:
11+
name: Release
12+
runs-on: ubuntu-latest
13+
permissions:
14+
contents: write
15+
id-token: write
16+
steps:
17+
- name: Checkout Repo
18+
uses: actions/checkout@v3
19+
20+
- name: 🟢 Setup
21+
uses: ./.github/common-actions/install
22+
23+
- name: 🗨️ Create Release Pull Request or Publish to NPM
24+
id: changesets
25+
uses: changesets/action@v1
26+
with:
27+
publish: pnpm npm:publish --no-git-checks --tag latest
28+
title: "🤖 ci(changesets): :package: version packages"
29+
commit: "🤖 ci(changesets): version packages"
30+
setupGitUser: false
31+
env:
32+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
33+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
34+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.gitignore‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
# Visual Studio Code #
3+
.vscode/
4+
**/.vscode/
5+
**/.vscode/*
6+
**/.vscode/**
7+
8+
# dependencies
9+
node_modules
10+
.pnp
11+
.pnp.js
12+
13+
# testing
14+
coverage
15+
16+
# next.js
17+
.next/
18+
out/
19+
20+
# production
21+
build
22+
**/build/**
23+
dist
24+
dist/**
25+
**/dist/**
26+
lib
27+
**/lib/**
28+
29+
# misc
30+
.DS_Store
31+
*.pem
32+
33+
# debug
34+
npm-debug.log*
35+
yarn-debug.log*
36+
yarn-error.log*
37+
.pnpm-debug.log*
38+
39+
# local env files
40+
.env*.local
41+
42+
# vercel
43+
.vercel
44+
45+
# typescript
46+
*.tsbuildinfo
47+
next-env.d.ts
48+
49+
# turbo
50+
.turbo
51+
.vscode/settings.json
52+
53+
**/%SystemDrive%/**
54+
55+
.env
56+
**/.env
57+
node_modules

‎.husky/pre-commit‎

Whitespace-only changes.

0 commit comments

Comments
 (0)