MagicConch

🐚 What is MagicConch?

If you have an unsolvable problem, ask the magic conch

🧙 Team

GP(Good People) & GP(Good Project)

김지환

남효정

이다정

최희원

💻 Stack

Demo

Getting Started

npm i magic-conch-soragodong

Usage

node node_modules/magic-conch-soragodong/cli.js

Contributing

• Code of Conduct

- [Issue guideline](https://github.com/NestIntro/MagicConch/tree/main/.github/ISSUE_TEMPLATE)

📢 Commit Message Conventions

Commit Message Format

It is consist of subject, body, and footer.

Each part is separated by a single line.

<Commit Type>: subject // 📝 you can describe shortly about your commit

body // 📝 if you have to describe more detaily what you did, you can write down on this part. It is optional

footer // 📝 this part exists for tracking issue.

📝 Here is an example

[Feat]: Add an authentication function   // subject part

User authentication was implemented using the Jwt token method // body part

Resolves: #18   // footer part

Commit Type

Must be one of the following:

• Feat: A new feature
• Fix: A bug fix
• Docs: Documentation only changes
• Style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
• Refactor: A code change that neither fixes a bug nor adds a feature
• Test: Adding missing or correcting existing tests
• Chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
• Design: Changes the Ui design (CSS, etc)
• Comment: Changes comments
• Init: Initial project setup
• Rename: Changes file/folder name or the path
• Remove: Files only remove

Subject Rule

• Subject cannot be longer 50 characters.
• don't use dot (.) at the end and special symbols.
• use the imperative, present tense: "change" not "changed" nor "changes"
• capitalize the first letter

Body Rule

• Basically, body can be written selectively.
  • 🤔 However, if it is not possible to explain simply with a subject, it is better to write it.
• The content of the text should be written in as much detail as possible regardless of the amount, but it should not exceed 80 characters.
• The content of the text must include an explanation of what was changed and why.

Footer Rule

[Issue tracker type]:#[Issue number]
ex-1). Resolves:#17
ex-2). Fixes: #17 Related to: #12, #16

• Footer is phrases for issue tracking.
  • 🤔 If it is not a commit linked to the issue, you can selectively write it.
• Specify the type of issue.
• When writing down multiple issue numbers, separate them with commas ().

Issue tracker type

Must be one of the following:

• Fixes: Fix an issue that has not yet been resolved
• Resolves: Issue resolved
• Ref: Issue exists for reference
• Related to: Unresolved issues associated with this commit

## 📜 License

This software is provided under MIT License.