Creamie is currently developing at a good pace. Contributors are welcome to collaborate. Before, knocking on the door just go through the standard Contributing Open Source Guides. Read the Code of conduct to understand what actions you can and you cannot.
Once it is done, Fork the below repository and create your branch from master.
If you are not a VS code eslint/prettier extension fan. Just use
npm run lint to detect the status of code styling. Most probably when you are committing your code Husky will run linting and auto test cases.
New features or issues make sure you have a written test case that should meet all your workflow conditions.
Even though you have not run your tests on a local machine. While committing it will run a test and then allow you o push. After pushing into the codebase. Github webhooks will pass a request to run all the test cases on Travis CI where you can check the status. Also, we can view the status as a green label if it passed.
A set of rules on committing message style will make you a good contributor.
Commit message will be structured as below:
Type: chore, docs, feat, fix, refactor, style, or test. Message: use lowercase always
Go through Conventional commits for a detailed summary.
This operation will take place while you are including a new change on the package. Once you started development make sure the package you are developing should be synced to your 'Test' application.
Goto the package folder hit the below command. The Below command will create a local package into your machine.
Now you should include your local package in your test project.
So your setup is complete. While you are doing any changes in your local package will automatically sync to your
Once you have done your development on your branch. Just raise a pull request. Pull requests should be against the
master branch always.
Each PR should have a single feature/issue. If you have multiple changes make separate PRs for each change.
If you are looking for any clarification/help just ping us in below respective channels.
Start developing. CHEERS!