- Licensing and License Notices of This Project
- Source Code Guidelines
- Build Instructions
Submitting via Pull Request
- The authors of the commits have to sign off all commits of the pull request according to the Developer’s Certificate of Origin (DCO). You thereby confirm compliance with the DCO. Help regarding the version control Git can be found here.
- At least the main author has to sign the last commit with a PGP or SSH key. Signing helps to audit commit authorship. A quickstart and further guidelines for PGP can be found here.
API Compatibility
There is currently no guarantee of backwards compatibility. Absolute backward compatibility creates a maintenance burden, that currently has no benefits.
We do not break backward compatibility just for fun. Many API changes are located and categorized in the changelogs of the corresponding project. Breaking changes are tried to be omitted, but there is no guarantee for that.
You can try to decrease the likelihood of breaking a certain feature, by contributing an appropriate test case/suite for this feature. Regardless of that, keep in mind, that there is no guarantee of backwards compatibility.
TODO: Consider declaring backward compatibility a nice to have feature, instead of an absolute goal.
- Provide migrations guidelines or even automation via things like OpenRewrite for breaking changes.
- No Forward compatibility
- Versioning system and releases are needed in this case.
Helpful Notes
Browsing Repository in Browser
When browsing the repo in the web some browser addons/extension might help to visualize its content:
- PlantUML Visualizer for Firefox or Chrome. renders PlantUML images.
- TeX All the Things for Chrome can be used for rendering math formulas in a neat way.
Inspirational External Guidelines
- SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
- SPDX-FileCopyrightText: Contributors To The
net.splitcells.*Projects