Welcome!

We’re so glad you’re thinking about contributing to this U.S. Navy open source project! If you’re unsure about anything, just ask – or submit the issue or pull request anyway. The worst that can happen is you’ll be politely asked to change something. We love all friendly contributions.

Guidance on how to contribute

There are two primary ways to help:

Using the issue tracker

Use the issue tracker to suggest feature requests, report bugs, and ask questions. This is also a great way to connect with the developers of the project as well as others who are interested in this solution.

Use the issue tracker to find ways to contribute. Find a bug or a feature, mention in the issue that you will take on that effort, then follow the Changing the code-base guidance below.

Changing the code-base

Generally speaking, you should fork this repository, make changes in your own fork, and then submit a pull-request. All new code should have associated unit tests that validate implemented features and the presence or lack of defects. Additionally, the code should follow any stylistic and architectural guidelines prescribed by the project. In the absence of such guidelines, mimic the styles and patterns in the existing code-base.

Public domain

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.

License

Software code created by U.S. Government employees is not subject to copyright in the United States (17 U.S.C. §105). The United States Department of the Navy (DON) all rights to seek and obtain copyright protection in countries other than the United States for Software authored in its entirety by the Department of Navy. To this end, the DON hereby grants to recipients a royalty-free, nonexclusive license to use, copy, and create derivative works of the software outside of the United States.

Disclaimer

The DON’s GitHub project code is provided on an “as-is” basis and the user assumes responsibility for its use. DON has relinquished control of the information and no longer has responsibility to protect the integrity, confidentiality, or availability of the information. Any claims against the DON stemming from the use of its GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the DON. The Department of the Navy seal and logo, or the seal and logo of a DON command or unit, shall not be used in any manner to imply endorsement of any commercial product or activity by DON or the United States government.

Privacy

Please read