From 74c4ba4c0e660ab3a8fffd65606e4924be01d400 Mon Sep 17 00:00:00 2001 From: Tw93 Date: Thu, 10 Nov 2022 09:48:06 +0800 Subject: [PATCH] =?UTF-8?q?:bug:=20=E6=9B=B4=E6=96=B0=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..edd8441 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,26 @@ +## How to contribute to Pake + +**Welcome to create [pull requests](https://github.com/tw93/Pake/compare/) for bugfix, new component, doc, example, suggestion and anything.** + +## Branch Management + +```txt +master + ↑ +dev <--- Develop/PR +``` + +- `dev` branch + - `dev` is the developing branch. + - It's **RECOMMENDED** to commit feature PR to `dev`. +- `master` branch + - `master` is the release branch, we will make tag and publish version on this branch. + - If it is a document modification, it can be submitted to this branch. + +## Commit Log + +please use + +## More + +It is a good habit to create a feature request issue to discuss whether the feature is necessary before you implement it. However, it's unnecessary to create an issue to claim that you found a typo or improved the readability of documentation, just create a pull request.