1.7 KiB
1.7 KiB
How to Contribute
🎉 We really appreciate you taking the time to improve this project! 🎉
To ensure that the blog design is not confusing, this project does not accept suggestions for design changes, such as color scheme, fonts, typography, etc. If your request is about an enhancement, it is recommended to first submit a Feature Request issue to discuss whether your idea fits the project.
Basically, you can follow these steps to complete the contribution.
- Fork this project on GitHub and clone it locally.
- Create a new branch from the default branch and give it a descriptive name
(format:
feature/<add-new-feat>orfix/<fix-a-bug>). - After completing development, create a Conventional Commit with git. (See also: "Verify the commits")
- Create a Pull Request.
Make sure you can pass the CI tests
This project has CI turned on. In order for your PR to pass the test, please read the following.
Check the core functionality
bash ./tools/test
Check the SASS syntax style
npm test
Verify the commits
Before you create a git commit, please complete the following setup.
Install commitlint & husky:
npm i -g @commitlint/{cli,config-conventional} husky
And then enable husky:
husky install