Contributing to Violet
We appreciate any help, in particular we would like to see:
Sophisticated conversational applications built on top of this project. As you build it, let us know how it went. What worked well? What was challenging?
Tests: It is the best way for you to make sure that as we improve the framework that we don’t break a use case that you are depending on.
File issues: If something is not working as expected or if you want to see am improvement, please file an issue or enhancement reqest on the project.
We are excited to have you contribute to this project!
If you are a new contributor, please sign, scan, and send the Salesforce Contributor License Agreement to email@example.com.
Search for an existing issue. If none exists, create a new issue so that other contributors can keep track of what you are trying to add/fix and offer suggestions (or let you know if there is already an effort in progress).
Fork the repo on GitHub.
Clone the project to your own machine.
Commit changes to your own branch.
Push your work back up to your fork.
Submit a Pull Request so that we can review your changes.
NOTE: Be sure to merge the latest from
master before making a pull request!
When we review any commits we will check to make sure:
- All tests need to pass.
- Any new code needs to have tests.
- Comments need to be there - at the module-level, function-level, as well as any interesting or complex blocks of code.
Keep an eye on dependencies:
- Licenses that we are ok to use: BSD, Apache 2.0, MIT, ISC, MPL
- Licenses that we will need to check with legal: GPL v2, LGPL
- Licenses that we cannot use: GPL v3 and Affero GPL
Copyright and Licensing
See the license information in the project.