Skip to content

Latest commit

 

History

History
71 lines (61 loc) · 3.95 KB

CONTRIBUTING.md

File metadata and controls

71 lines (61 loc) · 3.95 KB
Raw

Contribution Requirements

If you would like to contribute to this project, please open a pull request.

Contributors must follow the guidelines below:

  1. When making commits, use the --signoff/-s option to git commit. By doing so, you are certifying that you have the rights to submit this work under the same license used by this project and agree to the Developer Certificate of Origin.
  2. Include detailed commit messages that start with a short subject line, followed by a blank line, followed by a longer description that documents what the commit changes and why. See How to Write a Git Commit Message for further helpful guidance.
  3. Organize commits into cohesive, functional units, such that each commit fully implements an entire feature or bugfix, and the code works at each point in the commit history. I.e., don't include multiple commits where the first commit is a buggy implementation of a feature, and the following commits fix bugs that exist in the first commit. It is okay to develop in this way, but these commits must be squashed before opening the pull request.
  4. Address feedback received in the pull request as additional commits. Then once approval is attained, squash bugfixes and feedback commits into the original commit(s) as appropriate per guideline #2 above. The reason for the separate commits addressing feedback is that it provides an easy way for reviewers to see only what changed if desired.
  5. Update the CHANGELOG.md file with your changes. This project follows the conventions described by the Keep a Changelog project. Add a description of changes to the [Unreleased] section of CHANGELOG.md, and add them to the appropriate subsection based on the type of changes: Added, Changed, Deprecated, Removed, Fixed, or Security. The maintainers of this project will decide when to issue a new release, and at that time, the [Unreleased] section will be renamed to indicate the release version based on Semantic Versioning, and a new [Unreleased] section will be created to track changes for the next release.
  6. When a new release is issued, the container version should be updated to match the version in CHANGELOG.md. The container is versioned based on the contents of the .version file in the root of the repository.
  7. Contributions which require updates to the documentation should have the associated documentation changes submitted as pull requests to the sat-docs repository. Documentation changes should follow the guidelines given in that repository, including writing style requirements.

Developer Documentation

See Developer Documentation in this repository for more information.

Copying

(C) Copyright 2019-2020 Hewlett Packard Enterprise Development LP.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.