Skip to content

Commit 33047e9

Browse files
committed
update 8 files and create 2 files
1 parent aecf31d commit 33047e9

File tree

10 files changed

+498
-67
lines changed

10 files changed

+498
-67
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ about: Create a report to help us improve
44
title: ''
55
labels: bug
66
assignees: ''
7-
87
---
98

109
**Describe the bug**
1110
A clear and concise description of what the bug is.
1211

1312
**To Reproduce**
1413
Steps to reproduce the behavior:
14+
1515
1. Go to '...'
1616
2. Click on '....'
1717
3. Scroll down to '....'
@@ -24,4 +24,4 @@ A clear and concise description of what you expected to happen.
2424
If applicable, add screenshots to help explain your problem.
2525

2626
**Additional context**
27-
Add any other context about the problem here.
27+
Add any other context about the problem here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ Please describe the tests that you ran to verify your changes. Provide instructi
2020
- [ ] Test A
2121
- [ ] Test B
2222

23-
## Checklist:
23+
## Checklist
2424

2525
- [ ] My code follows the style guidelines of this project
2626
- [ ] I have performed a self-review of my own code
2727
- [ ] I have commented my code, particularly in hard-to-understand areas
2828
- [ ] I have made corresponding changes to the documentation
2929
- [ ] My changes generate no new warnings
3030
- [ ] I have added tests that prove my fix is effective or that my feature works
31-
- [ ] New and existing unit tests pass locally with my changes
31+
- [ ] New and existing unit tests pass locally with my changes

.gitignore

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
# Dependencies
2-
/node_modules
3-
41
# Logs
52
logs
63
*.log
@@ -9,18 +6,13 @@ yarn-debug.log*
96
yarn-error.log*
107
lerna-debug.log*
118

12-
# Diagnostic reports (https://nodejs.org/api/report.html)
13-
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
14-
15-
# Test coverage
16-
/coverage
9+
# Dependency directories
10+
node_modules/
1711

18-
# Build output
19-
/dist
20-
/build
12+
# Coverage directory
13+
coverage/
2114

22-
# Misc
23-
.DS_Store
15+
# Environment variables
2416
.env
2517
.env.local
2618
.env.development.local

CODE_OF_CONDUCT.md

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
shytiger@yahoo.com
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interaction in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of...
104+
105+
### 4. Permanent Ban
106+
107+
**Community Impact**: Demonstrating a pattern of violation of community
108+
standards, including sustained inappropriate behavior, harassment of an
109+
individual, or aggression toward or disparagement of classes of individuals.
110+
111+
**Consequence**: A permanent ban from any sort of public interaction within
112+
the community.
113+
114+
## Attribution
115+
116+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
117+
version 2.1, available at
118+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
119+
120+
[homepage]: https://www.contributor-covenant.org
121+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

CONTRIBUTING.md

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
# Contributing to js-quality-starter
2+
3+
We welcome contributions to the `js-quality-starter` template! By contributing, you help improve this foundation for JavaScript projects for everyone.
4+
5+
Please take a moment to review this document to understand our contribution guidelines.
6+
7+
## Table of Contents
8+
9+
- Code of Conduct
10+
- How to Contribute
11+
- Reporting Bugs
12+
- Suggesting Enhancements
13+
- Your First Code Contribution
14+
- Pull Request Guidelines
15+
- Development Setup
16+
- Code Style
17+
- Testing
18+
- Commit Messages
19+
- License
20+
21+
## Code of Conduct
22+
23+
This project and everyone participating in it is governed by the [js-quality-starter Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to shytiger@yahoo.com.
24+
25+
## How to Contribute
26+
27+
### Reporting Bugs
28+
29+
If you find a bug in the template or its configurations, please open an issue using the Bug Report template.
30+
31+
Before opening a new bug report, please check if a similar issue already exists. When reporting, provide:
32+
33+
- A clear and concise description of the bug.
34+
- Steps to reproduce the behavior.
35+
- Expected behavior.
36+
- Screenshots or code snippets if applicable.
37+
- Any additional context (e.g., Node.js version, OS).
38+
39+
### Suggesting Enhancements
40+
41+
We're always looking for ways to improve this template! If you have an idea for a new feature or an improvement, please open an issue.
42+
43+
Describe the enhancement, why it would be useful, and provide any relevant examples or mockups.
44+
45+
### Your First Code Contribution
46+
47+
If you're new to contributing to open source or this project, here's a general workflow:
48+
49+
1. **Fork** this repository to your own GitHub account.
50+
2. **Clone** your forked repository to your local machine:
51+
52+
```bash
53+
git clone https://github.com/your-username/your-forked-repo.git # Replace with your forked repository URL
54+
cd js-quality-starter
55+
```
56+
57+
3. **Install dependencies**:
58+
59+
```bash
60+
npm install
61+
```
62+
63+
4. **Create a new branch** for your changes:
64+
65+
```bash
66+
git checkout -b feature/your-feature-name
67+
# or bugfix/your-bug-fix-name
68+
```
69+
70+
5. Make your changes.
71+
6. **Test** your changes (see Testing).
72+
7. **Commit** your changes (see Commit Messages).
73+
8. **Push** your branch to your forked repository:
74+
75+
```bash
76+
git push origin feature/your-feature-name
77+
```
78+
79+
9. Open a **Pull Request** to the `main` branch of the original `js-quality-starter` repository.
80+
81+
### Pull Request Guidelines
82+
83+
When submitting a pull request, please ensure:
84+
85+
- You have read and followed the Pull Request Template.
86+
- Your branch is up-to-date with the `main` branch of this repository.
87+
- Your code adheres to the project's Code Style.
88+
- All existing tests pass, and new tests are added for new features or bug fixes.
89+
- Your commit messages are clear and follow the Commit Messages guidelines.
90+
- The PR description clearly explains the problem your PR solves and how it solves it.
91+
92+
## Development Setup
93+
94+
After cloning the repository and running `npm install`, the pre-commit hooks (managed by Husky and lint-staged) will be automatically set up. This ensures that your code is linted and formatted before every commit.
95+
96+
## Code Style
97+
98+
This project enforces code style using ESLint and Prettier.
99+
100+
- `npm run lint`: Checks for linting errors.
101+
- `npm run lint:fix`: Automatically fixes fixable linting errors.
102+
- `npm run format`: Checks for formatting issues.
103+
- `npm run format:fix`: Automatically formats files.
104+
105+
Pre-commit hooks will automatically run `eslint --fix` and `prettier --write` on staged files.
106+
107+
## Testing
108+
109+
Tests are written using Jest.
110+
111+
- `npm test`: Runs all tests.
112+
113+
Please ensure all existing tests pass before submitting a pull request. If you are adding new features or fixing bugs, please include new tests to cover your changes.
114+
115+
## Commit Messages
116+
117+
We encourage the use of Conventional Commits for clear and consistent commit history. Examples:
118+
119+
- `feat: Add new feature for X`
120+
- `fix: Resolve bug in Y component`
121+
- `docs: Update README with Z section`
122+
- `chore: Update dependencies`
123+
124+
## License
125+
126+
By contributing to `js-quality-starter`, you agree that your contributions will be licensed under its MIT License.

LICENSE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
MIT License
1+
# MIT License
22

3-
Copyright (c) [year] [fullname]
3+
Copyright (c) 2025 ioncakephper
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
1818
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
21+
SOFTWARE.

0 commit comments

Comments
 (0)