Skip to content

Commit

Permalink
🚀Init: add boilerplate files!
Browse files Browse the repository at this point in the history
  • Loading branch information
INeedJobToStartWork committed Aug 27, 2024
1 parent 3cdba48 commit a5bcc8b
Show file tree
Hide file tree
Showing 16 changed files with 8,546 additions and 0 deletions.
8 changes: 8 additions & 0 deletions .changeset/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Changesets

Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works with
multi-package repos, or single-package repos to help you version and publish your code. You can find the full
documentation for it [in our repository](https://github.com/changesets/changesets)

We have a quick list of common questions to get you started engaging with this project in
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
12 changes: 12 additions & 0 deletions .changeset/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
"changelog": "@changesets/cli/changelog",
"commit": false,
"fixed": [],

"linked": [],
"access": "public",
"baseBranch": "main",
"updateInternalDependencies": "patch",
"ignore": []
}
100 changes: 100 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
name: "🐞 Report a bug"
title: "🐞[BUG] - <TITLE_OF_ISSUE>"
description: Create new report!
labels: [bug]
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to report a bug to BetterNPM repo! 🙏
If you have a question about how to achieve something and are struggling, please post a question
inside of either of the following places:
- BetterNPM's 💬[Discussion's tab](https://github.com/INeedJobToStartWork/BetterNPM/discussions)
Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already:
- BetterNPM's [Issue's tab](https://github.com/INeedJobToStartWork/BetterNPM/issues)
- BetterNPM's [closed issues tab](https://github.com/INeedJobToStartWork/BetterNPM/issues?q=is%3Aissue+is%3Aclosed)
- BetterNPM's [Discussions tab](https://github.com/INeedJobToStartWork/BetterNPM/discussions)
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.
It'll help us to triage your issue as quickly as possible.
- type: input
id: description
attributes:
label: Issue Description
description: Please give a short description of the issue
placeholder: Description title
validations:
required: true
- type: input
id: BetterNPM_version
attributes:
label: BetterNPM Version
description: Which BetterNPM version are you using?
placeholder: e.g. v0.5.0
validations:
required: true
- type: checkboxes
id: BetterNPM_latest
attributes:
label: Tested on Latest Version
description: Check if this issue is reproducible with the latest version - it could be fixed.
options:
- label: "Yes"
- type: input
id: reproductionLink
attributes:
label: Reproduction
description: Please provide a link to a reproduction on Github, CodeSandbox or StackBlitz.
placeholder: |
e.g. https://github.com/INeedJobToStartWork/xxx
- type: textarea
id: reproductionProcess
attributes:
label: Process to Reproduce bug
description: Please provide steps to reproduce the bug.
placeholder: |
e.g.
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
- type: textarea
id: reproductionImages
attributes:
label: Photo/Images Showing Bug
description: |
If applicable, please provide screenshots or photos showing the bug.
More about github attachments limits: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/attaching-files.
- type: textarea
id: reproductionLogs
attributes:
label: Logs
description: If applicable, please provide logs showing the bug (if exists).
- type: textarea
id: expectedBehavior
attributes:
label: What we got - What we expected
description: What did you expect to happen? What happened instead?
- type: textarea
id: additionalContext
attributes:
label: Additional Context
description: What did you wanted to do? Please provide any additional information here.
- type: textarea
id: triedFix
attributes:
label: What did you try to fix it?
description: What did you try to fix it? Every information is useful.
- type: textarea
id: howSolved
attributes:
label: How did you solve it?
description: How did you solve it? It's okay if you didn't solve it yet.
- type: textarea
id: possibleSolution
attributes:
label: How problem can be solved?
description: If you have any idea, please share it with us.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: 🤔 Long question or ideas?
url: https://github.com/INeedJobToStartWork/BetterNPM/discussions
about: Ask long-form questions and discuss ideas.
65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: "✨Idea - Feature Request"
title: "✨[Idea] - <TITLE_OF_ISSUE>"
description: Share your ideas with us!
labels: [feature]
body:
- type: markdown
attributes:
value: |
Wow, good to see you there!
It's good to know you're creative ✨
Before submitting a new feature request, please check the links below to see if there somebody already requested it:
- BetterNPM's [Issue's tab](https://github.com/INeedJobToStartWork/BetterNPM/issues)
- BetterNPM's [closed issues tab](https://github.com/INeedJobToStartWork/BetterNPM/issues?q=is%3Aissue+is%3Aclosed)
- BetterNPM's [Discussions tab](https://github.com/INeedJobToStartWork/BetterNPM/discussions)
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.
- type: input
id: idea
attributes:
label: Idea ✨
description: Please give a short description of the feature
placeholder: e.g. I want to add cooldown to button
validations:
required: true

- type: input
id: work
attributes:
label: How it should work?
description: Give a description of how it should work
placeholder: |
e.g After clicking button, it should be disabled for X seconds
validations:
required: true

- type: input
id: solution
attributes:
label: What it gonna solve? Why we should ad it?
description: How it will help you and others? What kind of problems it will solve?.
placeholder: |
e.g It will help me and users to prevent api calls spamming and give a better user experience.
validations:
required: true

- type: input
id: implementation
attributes:
label: How it should be implemented?
description: What do you expect, how it should be implemented? Which props?

validations:
required: true

- type: input
id: example
attributes:
label: Example of usage / I have seen it in other library
description: |
You can give a link to currently implemented feature in other library / give your own example.
(Images, videos, code snippets, etc.)
placeholder: |
e.g Similar feature is implemented in XXX lib.
Here is link: XXXX
23 changes: 23 additions & 0 deletions .github/common-actions/install/action.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: 'install'
description: 'Sets up Node.js and runs install'

runs:
using: 'composite'
steps:
- name: 🚀 Setup pnpm
uses: pnpm/action-setup@v4
- name: 🟢 Setup node
uses: actions/[email protected]
with:
node-version-file: '.nvmrc'
registry-url: 'https://registry.npmjs.org'
cache: 'pnpm'

- name: 🤖 Setup Git User
shell: bash
run: |
git config --global user.email "[email protected]"
git config --global user.name "INEEDJ"
- name: ↘️ Install dependencies
shell: bash
run: pnpm install --no-frozen-lockfile
20 changes: 20 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: CI/CD
on:
push:
branches: [main]
pull_request:
branches: [main]
jobs:
Deploy:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- name: 🟢 Setup
uses: ./.github/common-actions/install
- name: 📝 Lint
run: pnpm lint
- name: ♻️ Format
run: pnpm format
- name: 🏗️ Build Package
run: pnpm build:npm
34 changes: 34 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Publish Package to npmjs
on:
push:
branches:
- main

concurrency: ${{ github.workflow }}-${{ github.ref }}

jobs:
release:
name: Release
runs-on: ubuntu-latest
permissions:
contents: write
id-token: write
steps:
- name: Checkout Repo
uses: actions/checkout@v3

- name: 🟢 Setup
uses: ./.github/common-actions/install

- name: 🗨️ Create Release Pull Request or Publish to NPM
id: changesets
uses: changesets/action@v1
with:
publish: pnpm npm:publish --no-git-checks --tag latest
title: "🤖 ci(changesets): :package: version packages"
commit: "🤖 ci(changesets): version packages"
setupGitUser: false
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
57 changes: 57 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
# Visual Studio Code #
.vscode/
**/.vscode/
**/.vscode/*
**/.vscode/**

# dependencies
node_modules
.pnp
.pnp.js

# testing
coverage

# next.js
.next/
out/

# production
build
**/build/**
dist
dist/**
**/dist/**
lib
**/lib/**

# misc
.DS_Store
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*
.pnpm-debug.log*

# local env files
.env*.local

# vercel
.vercel

# typescript
*.tsbuildinfo
next-env.d.ts

# turbo
.turbo
.vscode/settings.json

**/%SystemDrive%/**

.env
**/.env
node_modules
Empty file added .husky/pre-commit
Empty file.
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
20
Loading

0 comments on commit a5bcc8b

Please sign in to comment.