- Love your input! Contributing to this project should be as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
- GitHub flow is used
- Your pull requests are actively welcomed.
- The steps:
- Fork the repo and create your branch from master.
- If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that pull request!
- 🙏 DO
- Document your changes in the pull request
- 💡 Check developer notes if you need help
- ❗ DON'T
- Do not update the versions, current version is only set by the maintainer and updated automatically by bump-everywhere
- Create a pull request for application.yaml
- 🙏 For any new script, try to add
revertCode
that'll revert the changes caused by the script. - See typings for documentation as code.
- There are two types of components:
- Stateless, extends
Vue
- Stateful, extends
StatefulVue
- The source of truth for the state lies in application layer and must be updated from the views if they're mutating the state
- They mutate or/and reacts to changes in application state.
- You can react by getting the state and listening to it and update the view accordingly in
mounted()
method.
- Stateless, extends
By contributing, you agree that your contributions will be licensed under its GNU General Public License v3.0.