-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: enhance contribution guidelines for pull requests
- Loading branch information
Showing
1 changed file
with
32 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
## Hi! I would be very happy if you could help develop this project. It is very important to me. | ||
|
||
### Before submitting a pull request, please follow these rules: | ||
|
||
1. **Commit Prefixes**: Check the correctness of the commit prefixes. Choose the most appropriate prefix for your changes by referring to the `commitlint.config.js` file. | ||
2. **Code Quality**: Ensure that your code adheres to the formatting and linting rules: | ||
- Run the following commands to check and fix code formatting before submitting: | ||
- To check formatting: | ||
```bash | ||
npm run prettier | ||
``` | ||
- To fix formatting: | ||
```bash | ||
npm run prettier:fix | ||
``` | ||
- To check linting: | ||
```bash | ||
npm run lint | ||
``` | ||
- To fix linting issues: | ||
```bash | ||
npm run lint:fix | ||
``` | ||
3. **Tests**: Make sure all tests pass successfully. You can run the tests with: | ||
|
||
```bash | ||
npm run test | ||
``` | ||
|
||
--- | ||
|
||
### Thank you for your contributions! I appreciate your effort in maintaining the quality of this project!! |