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:
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.
Do you want a new template? Check out the adding new templates guide also in the Docs folder.
Do you wish a feature existed? Either suggest it from the issues tab or try creating it your self.
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
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.
- If you have mint installed globaly
npm uninstall -g mintbean-cli
- Fork the repository
git clone <fork>
- Link it to your global packages
npm link
- Create a branch with the propre type and descriptive name of the changes
git checkout -b type/[branch-name]
- Apply your changes
- Open a pull request against the main branch
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 |