2.5 KiB
Contributions to Nearenough are welcomed!
Process
- 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
Notes
- Keep pull requests limited to a single issue.
- Keep whitespace-only commits separate from other code changes. If needed commit your new feature or fix first then follow with a separate whitespace/style commit.
Testing
- Any pull request that causes the test suite to fail will be rejected.
- New features/functionality require new tests.
- Bugfixes should be accompanied by a test case covering the bug.
- A pull request that reduces code coverage will likely be rejected.
Style/Coding Standard
- Java 8
- Java code must comply with the Google Java Style Guide. This is strictly enforced.
- All files use unix (LF) line endings
External Dependencies
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.
Contributions that introduce new external dependencies are very likely to be rejected.
Licensing of Contributions
Section 5 of the Apache 2.0 license describes how contributions are handled:
- 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.
Contributor License Agreement
One-liners, simple fixes, and other minor changes do not require a CLA. They are handled as per
Section 5 of the Apache 2.0 license. Prior to being merged into master you will be asked:
- To confirm you are the original author of the work.
- To 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.
Substantial contributions do require a completed Contributor License Agreement (CLA) prior to them being accepted. The definition of "substantial" is fuzzy, but we'll know it when we see it. Please contact stuart{at}int08h.com to get the CLA submitted.