CONTRIBUTING.md

Table of Contents generated with DocToc

• Contributing guidelines
  • Commit sign-off
  • Contributions
  • Certificate of Origin
  • Contributing A Patch
  • Issue and Pull Request Management
  • Pre-check before submitting a PR

Commit sign-off

To commit your changes, you would need to sign off on your commit:

git commit -s -m ....

To amend a previous commit:

git commit --amend --signoff

You can also mass sign-off a whole pull request with

git rebase --signoff ${BASE_BRANCH_NAME}

Contributing guidelines

Contributions

All contributions to the repository must be submitted under the terms of the Apache Public License 2.0.

Certificate of Origin

By contributing to this project you agree to the Developer Certificate of Origin (DCO). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution. See the DCO file for details.

Contributing A Patch

1. Submit an issue describing your proposed change to the repo in question.
2. The repo owners will respond to your issue promptly.
3. Fork the desired repo, develop and test your code changes.
4. Submit a pull request.

Issue and Pull Request Management

Anyone may comment on issues and submit reviews for pull requests. However, in order to be assigned an issue or pull request, you must be a member of the stolostron GitHub organization.

Repo maintainers can assign you an issue or pull request by leaving a /assign <your Github ID> comment on the issue or pull request.

Pre-check before submitting a PR

After your PR is ready to commit, please run following commands to check your code.

npm test
npm run lint

Now, you can follow the getting started guide to work with the stolostron console-api repository.