1.1.1 • Published 2 years ago
@yetanothertool/org-formation-mermaidjs v1.1.1
About
MermaidJS gwenerator using the organization.yml file
Technologies
This section covers the tools and packages used for the project,
- NodeJS
- org-formation
- mermaidjs
Getting Started
Prerequisites
- NodeJS
- AWS
Installation
npm install -g @yetanothertool/org-formation-mermaidjs
Usage
CLI
yat-org-formation-mermaidjs ./organization.yml
Contributing
- Create a Feature Branch
- Commit your changes
- Push your changes
- Create a PR
Branch Checkout:
git checkout -b <feature|fix|release|chore|hotfix>/prefix-name
Your branch name must starts with feature|fix|release|chore|hotfix and use a / before the name; Use hyphens as separator; The prefix correspond to your Kanban tool id (e.g. abc-123)
Keep your branch synced:
git fetch origin
git rebase origin/master
Commit your changes:
git add .
git commit -m "<feat|ci|test|docs|build|chore|style|refactor|perf|BREAKING CHANGE>: commit message"
Follow this convention commitlint for your commit message structure
Push your changes:
git push origin <feature|fix|release|chore|hotfix>/prefix-name
Examples:
git checkout -b release/v1.15.5
git checkout -b feature/abc-123-something-awesome
git checkout -b hotfix/abc-432-something-bad-to-fix
git commit -m "docs: added awesome documentation"
git commit -m "feat: added new feature"
git commit -m "test: added tests"
License
Distributed under the MIT License. See LICENSE for more information.
Contact
- Tommy Gingras @ tommy@studiowebux.com