Skip to content

Latest commit

 

History

History
104 lines (64 loc) · 2.87 KB

README.md

File metadata and controls

104 lines (64 loc) · 2.87 KB

Shifumi App

Git View Logo
A simple shifumi app. Try beat the computer random's choice.
Using ReactJs, ViteJs and Typescript


App version Netlify Status

📖 Table of content

  1. Getting Started
  2. Git guidelines
  3. Release guidelines
  4. Architecture

⚒️ Getting Started

Installation

yarn

Start development server

yarn dev

Build for production

yarn build

Build preview

yarn preview

💀 Git guidelines

⚠️ One branch for each feature, fix, or other

🎁 Branches and commits

🚂 Naming branches prefix

fix- / feat- / etc.

Example : fix-branch-name feat-feature-name

🚃 Naming for commits inside a branch

Any understandable name describing the commit

Example : Add color Fix component margins

🛫 Pull requests

📝 Naming

Using Angular commit message convention see here

<type>(<scope>): <short summary>

Pull requests formatted according to the Angular convention will automatically create a release note listing features, fixes or updates.

🚚 Method

Squash commits and delete merged branch

Allow to keep a clean git history and avoid merge conflicts.

🧑‍✈️ Pipelines (ToDo)

Unit tests / e2e tests

🔬 Development branch

It contains only PR commits formatted with the Angular commit convention. This means you can quickly revert features, fixes or other modifications.

🚀 Release guidelines

⚠️ Every new pull request pushed on the main branch will trigger a new release.

  1. Create a pull request with the new version number in the title. From dev to main.
  2. When all tests are passed, without commit squash, merge the pull request on main
  3. Semantic release will automatically create a new release and update the package.json version number. The release note will be generated automatically and added to the release.
  4. Update dev branch with the new main branch.