๐ Contributing to Paint Board ๐ฅณ
March 20, 2025 ยท View on GitHub
First of all, thank you very much for considering contributing to our project! We welcome any kind of contribution, whether it's proposing new functional features, improving code, fixing bugs, or improving documentation.
This guide will provide all the relevant information to help you get started working on this project. Please take a few minutes to read it, it will help us collaborate better and create a better project together.
Submit Issue
Before jumping into a PR be sure to search existing PRs or issues for an open or closed item that relates to your submission.
If it's a bug fix, please raise it in an Issue first.
In the case of new feature additions, please communicate with us first in Discussions or contact us directly via the contact information provided.
Pull Requests Steps
- Fork this project's repo on Github
- Create a new branch on your local copy to develop new features, fix bugs, or make other contributions,
git checkout -b feat/xxxx - Submit your changes:
git commit -am 'feat: add xxxxx' - Push your branch:
git push origin feat/xxxx - To submit a
Pull Request, make sure your source branch is the one you just pushed, and your target branch is thedevbranch of the Paint Board project. - After submitting, watch out for emails and notifications associated with the Pull request. Once it's approved, we'll merge it into the
mainbranch as planned. Doing a new round of releases
Development Environment
- Node.js 18 +
- Pnpm 8 +
Code Style
Please follow the node-style-guide
Commit Messages
Please follow the Angular
Please keep the commit message in English for better understanding by all developers.
featAdd new featuresfixFix the problem/BUGstyleThe code style is related and does not affect the running resultperfOptimization/performance improvementrefactorRefactorrevertUndo edittestTest relateddocsDocumentation/noteschoreDependency update/scaffolding configuration modification etc.workflowWorkflow improvementsciContinuous integrationtypesType definition file changeswipIn development
Code Content
Please keep the code comments and code content in English for better understanding by all developers.
Contact Details
- Email: song.lhlh@gmail.com
- Telegram: https://t.me/longhao_song
- WeChat: