22 lines
1.2 KiB
Markdown
22 lines
1.2 KiB
Markdown
# Contributing to Voiced
|
|
|
|
Contributions are welcome: bug reports, fixes, templates, translations and documentation.
|
|
|
|
1. Open an issue first for anything larger than a small fix, so the work is not duplicated.
|
|
2. Branch from `main`. Keep a change focused on one thing.
|
|
3. Run the gates from `docs/RELEASE.md` that your change touches: `npm run build`, `npm test`, `npm run fonts:verify`
|
|
and `cargo test --manifest-path src-tauri/Cargo.toml`. Changes to the PDF engine or a template also need the
|
|
real-webview self-test (see the README, "Tests and gates").
|
|
4. Do not add personal data, real GSTINs, bank details or client names to code, tests, fixtures or screenshots. Use
|
|
synthetic values.
|
|
5. Open a pull request describing what changed and why.
|
|
|
|
By submitting a contribution you agree that it is licensed under the Apache License 2.0 (see `LICENSE`), the same
|
|
licence as the project, as described in section 5 of that licence.
|
|
|
|
## Using Voiced in your own project
|
|
|
|
You may fork, modify and redistribute Voiced under the Apache License 2.0. You must keep `LICENSE` and `NOTICE`,
|
|
keep the copyright notices, and mark files you changed. Please also credit the original: "Based on Voiced by
|
|
Bongbetic".
|