Contributing¶
Interested in contributing to the DSW development?
Ideas¶
If you have some idea (feature request) how to extend the DS Wizard, you can add it to our Ideas website or you can send us an email at support@ds-wizard.org.
Reporting¶
Bugs¶
In case you find some bug, please create an issue and provide requested information or contact us via email support@ds-wizard.org.
Vulnerabilities¶
Report security issues privately as described in Security Reports. Include the affected component and version, reproduction steps and possible impact. Do not publish sensitive details or logs in a public issue.
Development¶
Our projects are open source and you can contribute via GitHub (fork and pull request):
https://github.com/ds-wizard/engine-tools — document worker, mailer, TDK and rendering libraries
Note
Carefully read README and CONTRIBUTING files (if present) and also try to contact the main developer of the project for further details. You should follow the same code style, be DRY, and fit our overall architectures and structuring.
Test Policy¶
Testing is essential to ensure the successful construction and implementation of DSW. It is necessary to keep tests updated together with new features and other changes in the code.
Each component may use its own test suite (unit tests, acceptance tests, integration tests), which shall be described in the CONTRIBUTING file within the corresponding repository. To test all components together, we have the E2E test suite (Cypress) that tests according to various use cases, i.e., what can a user do within DSW using its web user interface.
Run the checks documented by the component repository and add tests for changed behavior. The repository’s CI workflow specifies its automated checks.
For reporting a security problem, follow Security Reports.
In case that a bug is found, it must be analyzed why tests did not find it. If possible and needed, test suites are extended to cover these (and similar) bugs.