Skip to content

Commit 7bc732d

Browse files
authored
Update CONTRIBUTING.md
1 parent bb5fe26 commit 7bc732d

File tree

1 file changed

+5
-78
lines changed

1 file changed

+5
-78
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing to js-quality-starter
1+
# Contributing to {{PROJECT_NAME}}
22

3-
We welcome contributions to the `js-quality-starter` template! By contributing, you help improve this foundation for JavaScript projects for everyone.
3+
We welcome contributions to the `{{PROJECT_NAME}}` template! By contributing, you help improve this foundation for JavaScript projects for everyone.
44

55
Please take a moment to review this document to understand our contribution guidelines.
66

@@ -20,7 +20,7 @@ Please take a moment to review this document to understand our contribution guid
2020

2121
## Code of Conduct
2222

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 [YOUR_PROJECT_CONTACT_EMAIL].
23+
This project and everyone participating in it is governed by the [{{PROJECT_NAME}} Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to {{CONTACT_EMAIL}}.
2424

2525
## How to Contribute
2626

@@ -50,79 +50,6 @@ If you're new to contributing to open source or this project, here's a general w
5050
2. **Clone** your forked repository to your local machine:
5151

5252
```bash
53-
git clone https://github.com/your-username/your-forked-repo.git # Replace with your forked repository URL
54-
cd js-quality-starter
53+
git clone [https://github.com/your-username/your-forked-repo.git](https://github.com/your-username/your-forked-repo.git) # Replace with your forked repository URL
54+
cd {{PROJECT_NAME}}
5555
```
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 lint:md:fix`: Automatically fixes fixable linting errors in Markdown files.
103-
- `npm run format`: Checks for formatting issues.
104-
- `npm run format:fix`: Automatically formats files.
105-
- `npm run format:md:fix`: Automatically formats Markdown files.
106-
107-
Pre-commit hooks will automatically run `eslint --fix` and `prettier --write` on staged files.
108-
109-
## Testing
110-
111-
Tests are written using Jest.
112-
113-
- `npm test`: Runs all tests.
114-
115-
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.
116-
117-
## Commit Messages
118-
119-
We encourage the use of Conventional Commits for clear and consistent commit history. Examples:
120-
121-
- `feat: Add new feature for X`
122-
- `fix: Resolve bug in Y component`
123-
- `docs: Update README with Z section`
124-
- `chore: Update dependencies`
125-
126-
## License
127-
128-
By contributing to `js-quality-starter`, you agree that your contributions will be licensed under its MIT License.

0 commit comments

Comments
 (0)