This file is still Work in Progress
Before you can start making changes it's mandatory to run a lerna bootstrap for installing all the dependencies.
After that you can start coding, the source folders are core, wrappers and plugins.
The core folder contains tsParticles library, the main library.
The wrappers folder contains all javascript frameworks wrappers built around tsParticles: Angular, jQuery, Preact, React, Vue.
The plugins folder contains all external presets and shapes.
Once done editing you can check if everything builds running lerna run build.
The difference is the first does not create the docs folder and it can be unnecessary while coding.
There's a small demo app inside the repository in the core folder, just run yarn start and go to http://localhost:3000
The wrappers and plugins doesn't have a demo app inside the repository for now.
A demo folder will be probably created in near future with all the demo apps needed.
Before opening any pull request check that lerna run build completes
The build task will be performed automatically by the CI\CD but a first local check should be done
If you want to contribute to the project please use dev as base branch.
Use master branch ONLY for critical bug fixes.
Once done create the Pull Request to dev branch, if it's a critical bug fix use staging.
This branch is the main development branch and it's the lowest priority branch under CI.
This branch should always build, sometimes can be necessary break this rule, this is why it's should and not must.
This branch is for testing the product before a new release.
This branch is the one used to make PR to master so this branch MUST build.
This branch is the production one.
This must be used for PR only for critical bug fixes and always MUST build.
Changes to README.md or other markdown files are not priorities so for these changes use dev or staging and they'll be implemented in the next release.
You can create any branch you want to push any kind of commits.
There are no rules in the CI for all other branches.
Once ready, if you need to implement in the product follow the rules above.
Remember to keep the backward compatibility with previous versions, if a changes breaks this rule must be discussed.
You can mark as obsolete old methods but they must work too. Deprecating is not breaking.
Feel free to join the Slack community to talk about the project. It's easier to share ideas if we can talk directly.
Happy coding to everyone!