Skip to content
This repository has been archived by the owner on Dec 7, 2021. It is now read-only.

Latest commit

 

History

History
22 lines (16 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

22 lines (16 loc) · 1.39 KB

Welcome! 👋

Hey! Thanks for your desire to contribute into Flame. Before submitting a PR please read all information below, it might be very helpful for you, just believe us.

General

Behave yourself well: don't open duplicate Pull Requests, keep all discussions without harassment, shitpost, racism etc. and just follow GitHub ToS.

Active Branches

This repository has only two branches. Each branch has it own version.

  • main — stable branch. It gets updates only after they were well-tested.
  • dev — development branch, related to Flame Canary#9955. It is unstable and may contain bugs, so if you want to add something new, please choose this branch and do not commit directly into main.

Code style

We are using eslint to keep our code pretty and enforce its style. You can run npm run lint:fix/yarn run lint:fix to fix all eslint problems.

Commit style

Our commits are based on conventional commits.

Examples:

  1. updated clear command ❌ Commit message is too inaccurate and not conventional.
  2. chore(ClearCommand): i did some changes to clear command ❌ Commit message does not include any useful information, and it's written in Simple Past.
  3. chore(ClearCommand): make second argument optional ✅ Everything is perfect!