Contributing to swiss-stage-project

I appreciate your consideration to contribute to this project!

This document is a guide to help make your contribution easier and more effective.

Getting Started

Prerequisites

• Node.js

  node --version
  v20.16.0

Installation

1. Clone the repository

   git clone https://github.com/takashi-ebina/swiss-stage-project.git

2. Move to the directory and install dependencies

   cd swiss-stage-project
   npm install

Development

• run the development server:

  npm run dev

  Open http://localhost:3000 with your browser to see the result.

• build:

  npm run build

• build electron:

  npm run electron:build

• run electron:

  npm run electron:dev

documentation

• run docs:

  npm run docs:dev

• run build:

  npm run docs:build

• run preview:

  npm run docs:preview

Branch Rules

Central Repository

• main

Develop Repository

• Branch Name
  • prefix/#issueID
• prefix
  • feature: Added functionality
  • bugfix: General bug fixes
  • hotfix: Prioritized bug fixes
  • refactor: refactoring
  • documentation: Documentation improvements or additions
  • other: others

Commit Rules

Commit Message

Prefix

• feat: a commit that adds new functionality.
• fix: a commit that fixes a bug.
• docs: a commit that adds or improves a documentation.
• style: changes that do not affect the meaning of the code.
• refactor: a code change that neither fixes a bug nor adds a feature.
• perf: a commit that improves performance, without functional changes.
• test: adding missing tests or correcting existing tests.
• chore: other changes that don't modify src or test files.

Label Rules

0. prefix

The priority of the issue.

• 0.high priority
• 0.Medium priority
• 0.low priority

1. prefix

The type of issue.

• 1.feature
• 1.bugfix
• 1.hotfix
• 1.refactor
• 1.documentation
• 1.other

Version Rules

Adopt Semantic Versioning.

Major.Minor.Patch

• Major
  • Incompatible changes.
• Minor
  • Backwards compatible and adds functionality.
• Patch
  • Backwards compatible bug fixes.