CONTRIBUTING.md

ligevan's Development Guidelines

Table of Contents

• ligevan's Development Guidelines
  • Table of Contents
  • Requirements
    • Tools
    • Extensions
  • Commit Conventions
  • Development

Requirements

Tools

• Environment: Node.js v20.17.0
  • You can download it from here.
• Package manager: yarn
  • To install it, run npm i -g yarn after installing Node.js.
  • Make sure install yarn v1 - aka yarn classic.
• Code editor: Visual Studio Code
  • You can download it from here.

Extensions

• EditorConfig for VS Code
• Prettier - Code formatter
• ESLint

Commit Conventions

Format: <type>: <subject>

Conventions:

• add: Add a new code what does not exist.
• update: Update an existing code.
• fix: Fix a bug, issue, or error, tool scan warning.
• docs: Update or add documentation.
• feat: Add a new feature. (Usually used in the PR title)
• refactor: Refactor an existing code.
• delete: Delete an existing code.

Examples:

• add: add a new feature
• update: update a function
• fix: fix a bug
• docs: update contributing guidelines
• feat: add a new feature
• refactor: refactor a function
• delete: delete a function

Note: Please follow the conventions to keep the commit history clean and easy to read.