Contributions to Nearenough are welcomed!
- Fork the repo and create a feature branch for your work
- Commit your work on the branch
- Ensure all tests pass
- Open a Pull Request
- Discuss and iterate
- Please run the test suite and ensure it passes
- New features/functionality require new tests
- Bugfixes should be accompanied by a test case covering the bug
- Google Java Style Guide
- Java 8
- Unix (LF) line endings
Nearenough should be as unencumbered as possible. The protocol
and client
packages in particular
strive to be bare-bones and may depend only on the Java 8 standard library, EdDSA-Java, and Netty.
Nearenough is Apache 2.0 licensed. Contributions are handled as per section 5:
Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
In your PR please:
- Confirm you are the original author of the work.
- State that you license the work to the Nearenough project under the Apache 2.0 license and that you have the legal authority to do so.