Open source should not be just about writing code. A good open source project also needs:
- Documentation writers
- Testers
- Tutorial writers
- Evangelists
- Automation builders
If you want to get involved in a role (including ones we may have missed!) reach out to one of the committers.
- Ensure there is a GitHub issue for any bug before submitting a PR.
- Enhancements should be discussed and a feature request issue created, before starting work on it.
- Fork and raise a PR for work.
- Add tests for any enhancements.
- Ensure documentation is updated accordingly, including adding unit test reports.
- Ensure API docs are updated (speak to an HCL-ite if required).
- Ensure changelog is updated.
- Develop code with Visual Studio Code and VoltScript extensions, see https://help.hcltechsw.com/docs/voltscript/early-access/howto/writing/index.html.
- Documentation uses Material for MKDocs framework:
- Write documentation in the relevant area of the docs directory.
- Preview documentation using MKDocs, either locally installed with relevant plugins or using the MKDocs HCL Container Image
In a Terminal, navigate to the directory containing the unit-tests-to-docs.sh file. Run the file, passing two parameters - a string matching part of the filename for the tests and a new folder name to push the results to. For example, ./unit-tests-to-docs.sh TestCol* TestCollections
## PRs
- When ready, complete a PR and submit.
- Review the requirements for submitting a PR, for example writing test and updating documentation.