Skip to content

Latest commit

 

History

History
73 lines (58 loc) · 3.63 KB

CONTRIBUTING.rst

File metadata and controls

73 lines (58 loc) · 3.63 KB
Raw
pytest Codecov NIST Public Domain

Contributing

Thank you for your interest in contributing! This document is in pre-pre-alpha stage, so feel free to make edits and suggestions through Pull Requests.

  • Until Hilbert gets to v1.0.X; the versioning will increment by 0.1 for every new release that adds new functionality.
  • Avoid adding external dependencies unless absolutely necessary -- try to stick to the SciPy stack.
  • All functional contributions should have associated tests added to the /hilbert/tests directory.
  • Testing is performed via pytest
  • Test coverage should be > 90%, with some exceptions
  • After contributing, please add your name to the bottom of the README file. No matter how small, all contributors will be recognized.
  • Gist of the release process

Style Notes

  • External imports (e.g., import numpy as _np) should have a prepended underscore to prevent code completion from identifying numpy as belonging to the pymcr module. (Demos and test files exempt).
  • Avoid all-capitalized variables unless constants.
  • For mathematical functions involving matrix math, capitalized and lower-case variables names are permissable to distinguish between vectors and matrices.

Commit Messages

  • I'm working on implementing a standardized notation for commit messages to facilitate auto-changelog. Comments encouraged (send me an email or leave an issue)

Branches

  • Work in progress here...

LICENSE

This software was developed by employees of the National Institute of Standards and Technology (NIST), an agency of the Federal Government. Pursuant to title 17 United States Code Section 105, works of NIST employees are not subject to copyright protection in the United States and are considered to be in the public domain. Permission to freely use, copy, modify, and distribute this software and its documentation without fee is hereby granted, provided that this notice and disclaimer of warranty appears in all copies.

THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY, CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.

Contact

Charles H Camp Jr: charles.camp@nist.gov