A big welcome and thank you for considering contributing to the open source projects! It’s people like you that make it a reality for users in our community.
We take our open source community seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our Code of Conduct.
- Make sure what you want to do complies with the [Design Principles] below.
- If there are major changes or special suggestions, please first discuss the change you wish to make via issue.
- Follow "Fork and Pull Request Workflow" throughout.
- Add your code snippets, please pay attention to adding them to different files according to the type. If the type file does not exist, create it and add its name to
package.json. - Maybe you should test the code snippets to make sure they work as you expect.
- Create your pull request.
- No unnecessary placeholders.
- ❌ if (condition) else { code }
- ✅ if () else {}
- Follow the regular code input sequence.
- ❌ function-public
- ✅ public-function
- Avoid short shortcuts that require special memorization.
- ❌ wl
- ✅ while-block
- Fork the repository to your own Github account
- Clone the project to your machine
- Create a branch locally with a succinct but descriptive name
- Commit changes to the branch
- Following any formatting and testing guidelines specific to this repo
- Push changes to your fork
- Open a PR in our repository and follow the PR template so that we can efficiently review the changes.