MenuExplore! Impressum Privacy Policy
☐
Contributing to Splitcells Network

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.

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.

Inspirational External Guidelines

Notes

Signing by PGP or SSH key is not required. Also, most open source projects do not do this and this does not seem to cause legal problems. The Linux Kernel does not sign commits and instead focuses on verifying the developer communication instead. Furthermore, all signature will be temporarily valid as well, which reduces it usefulness in practice, also it does not mean, that checking a repo regarding an expired key has not its use cases. On the other hand, commit signing creates a huge burden and has no benefits, if it is not used properly. Therefore, it is disregarded as a requirement.

  • SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
  • SPDX-FileCopyrightText: Contributors To The net.splitcells.* Projects