Skip to content

Latest commit

 

History

History
74 lines (51 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

74 lines (51 loc) · 1.62 KB
Raw

Contributing Guide

Note

You must follow the Code of Conduct.

I happily welcome your contributions! Before you contribute, I would recommend reading this guideline for a better development experience.




💬 Commit Message

I recommend you to follow Conventional Commits with this format.

type(scope): Description

Body

🎋 Pull Requests Branch

I use the dev branch for the temporary merging. When it's time to release, I'll merge the dev branch into the main branch.
For this reason, please fork the dev branch and open a PR to it.

flowchart LR
  subgraph PR Branches
    feature1
    feature2
    feature3
  end

  subgraph  Origin Branches
    dev
    main
  end

  feature1 & feature2 & feature3 -- Squash Merge --> dev
  dev -- Rebase Merge --> main

❓ Pull Requests Title

You don't need to add any prefixes like feature or bug fix to the Pull Requests title. 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.