Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

45 lines (31 loc) · 1.54 KB

Contributions to Nearenough are welcomed!

Process

  1. Fork the repo and create a feature branch for your work
  2. Commit your work on the branch
  3. Ensure all tests pass
  4. Open a Pull Request
  5. Discuss and iterate

Testing

  • 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

Style/Coding Standard

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.

Licensing of Contributions

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:

  1. Confirm you are the original author of the work.
  2. 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.