From 958f7a7cc7b8c4048ff4510a4de42f7b3acc4e6f Mon Sep 17 00:00:00 2001 From: 5ouma <101255979+5ouma@users.noreply.github.com> Date: Tue, 19 Mar 2024 16:03:40 +0900 Subject: [PATCH] docs(contributing): Add more information for contributors Make it easy to understand how to contribute. --- .github/CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 878a3e7..094d4f2 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -9,7 +9,24 @@ I would recommend reading this guideline for a better development experience.
+- [💬 Commit Message](#-commit-message) - [🔠 Branch Prefix](#-branch-prefix) +- [❓ Pull Requests Title](#-pull-requests-title) +- [🪵 Commit Log](#-commit-log) + +

+ +## 💬 Commit Message + +I recommend you to follow [Conventional Commits] with this format. + +```commit message +type(scope): Description + +Body +``` + +[Conventional Commits]: https://www.conventionalcommits.org
@@ -36,3 +53,18 @@ For the details of each label, please see [Labels](https://github.com/5ouma/opml | Type: Meta | `^meta-` | > Labels were generated with [@azu / github-label-setup](https://github.com/azu/github-label-setup) + +
+ +## ❓ Pull Requests Title + +You don't need to add any prefixes like `feature` or `bug fix` +to the Pull Requests title because I can recognize what kind of PR it is from labels. +Please give a clear title. + +
+ +## 🪵 Commit Log + +I do squash merge to the dev branch to keep the commit history clean. +When merging your Pull Request, I'll add the Conventional Commits type and scope.