Skip to content

Commit

Permalink
docs: add CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
LHRUN committed Jan 13, 2024
1 parent 316b605 commit 5e107ba
Showing 1 changed file with 62 additions and 0 deletions.
62 changes: 62 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# 🎉 Contributing to Paint Board 🥳

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](https://github.com/lhrun/paint-board/pulls) or [issues](https://github.com/lhrun/paint-board/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

1. Fork this project's repo on Github
2. Create a new branch on your local copy to develop new features, fix bugs, or make other contributions, `git checkout -b feat/xxxx`
3. Submit your changes: `git commit -am 'feat: add xxxxx'`
4. Push your branch: `git push origin feat/xxxx`
5. To submit a `Pull Request`, make sure your source branch is the one you just pushed, and your target branch is the `dev` branch of the Paint Board project.
6. After submitting, watch out for emails and notifications associated with the Pull request. Once it's approved, we'll merge it into the `main` branch as planned. Doing a new round of releases

## Development Environment

+ Node.js 16 +
+ Pnpm 8 +

## Code Style

Please follow the [node-style-guide](https://github.com/felixge/node-style-guide)

## Commit Messages

Please follow the [Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)

Please keep the commit message in English for better understanding by all developers.

- `feat` Add new features
- `fix` Fix the problem/BUG
- `style` The code style is related and does not affect the running result
- `perf` Optimization/performance improvement
- `refactor` Refactor
- `revert` Undo edit
- `test` Test related
- `docs` Documentation/notes
- `chore` Dependency update/scaffolding configuration modification etc.
- `workflow` Workflow improvements
- `ci` Continuous integration
- `types` Type definition file changes
- `wip` In development

## Code Content

Please keep the code comments and code content in English for better understanding by all developers.

## Contact Details

+ Email: [email protected]
+ Telegram: https://t.me/longhao_song
+ WeChat:
- <img style="width: 300px" src="https://raw.githubusercontent.com/LHRUN/file-store/main/paint-board/wechat.JPG" alt="wechat"/>

0 comments on commit 5e107ba

Please sign in to comment.