Skip to content
This repository was archived by the owner on Sep 13, 2021. It is now read-only.

Latest commit

 

History

History
59 lines (38 loc) · 1.77 KB

how_to_contribute.md

File metadata and controls

59 lines (38 loc) · 1.77 KB

Help! Help!

Hello!

Thank you for wanting to help our community by getting involved. Our tool is here to help, but needs a little help of its own. Below are some areas were you can lend a hand:

Docs

There is no such thing as too descriptive when it comes to documentation. If you feel like something in our docs could be better explained go for it.

Code

1. Project Templates

Do you want a new template? Check out the adding new templates guide also in the Docs folder.

2. Features

Do you wish a feature existed? Either suggest it from the issues tab or try creating it your self.

3. Solve an Issue

Navigate over to the issues tab and find an issue you want to solve there is a nifty labeling system to help you find one of your caliber.

The tags to look for are:

  • bug
  • documentation
  • help wanted
  • good first issue
  • enhancment
  • template

Issues/Bugs

Find an issue? Want to suggest a template? Want to suggest a feature? Create a Github issues by filling out one of our provided froms. Add any lables you think fit the task.

Getting Started

  1. If you have mint installed globalynpm uninstall -g mintbean-cli
  2. Fork the repository
  3. git clone <fork>
  4. Link it to your global packagesnpm link
  5. Create a branch with the propre type and descriptive name of the changesgit checkout -b type/[branch-name]
  6. Apply your changes
  7. Open a pull request against the main branch

Branch Types

type description
temp For adding templates to the CLI
feat For adding Features to the CLI
bug For fixing bugs in the CLI
docs For adding to the CLI or Templates documentation
sand For experimenting and spelunking
wip Works in progress; stuff I know won't be finished soon