CONTRIBUTING.md

Table of Contents generated with DocToc

• Contributing guidelines
  • Contributions
  • Certificate of Origin
  • Contributing A Patch
  • Issue and Pull Request Management
  • Development
    • Early Access
    • Useful Links
    • Environment Preparations
    • Project Layout
    • NPM Scripts
    • Launch Configurations

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 open-cluster-management 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.

Development

Early Access

Early-access pre-release is available here and will always reflect the current development snapshot from the main branch.

Useful Links

• VSCode API Documentation
• VSCode API References

Environment Preparations

All you need is VSCode and NodeJS.

Project Layout

• src contains the source code for the extension.
• test contains the sources for the unit tests.
• snippets contains the snippets offered by the extension.
• templates contains template files for orchestrating new projects.
• images contains various images used throughout the project.
• webview-ui contains the sources for react module providing the web view.

NPM Scripts

Install module dependencies:

npm i

Lint the project with eslint:

npm run lint

Test the project (sandbox tests):

npm test

Test the project skipping "slow" tests (sandbox tests):

New "slow" tests should include @slow in their description.

npm run test:quick

Print and verify coverage ratio (requires tests to be executed first):

npm run cov

Create an html coverage report (requires tests to be executed first):

npm run cov:rep

Build the project (including the web project):

npm run build

List all available scripts:

npm run

Launch Configurations

• Run Extension will run the extension in a separate vscode instance.
• Extension Tests will execute the tests in debug mode.