vscode-docker/CONTRIBUTING.md

24 строки
1.9 KiB
Markdown

# Contributing to Docker extension for VS Code
Welcome, and thank you for your interest in contributing to Docker extension for VS Code!. There are several of ways you can contribute to this extension.
## Ideas, feature requests, and bugs
We are open to all ideas and we want to get rid of bugs! Use the Issues section to either report a new issue, provide your ideas or contribute to existing threads.
## Documentation
The primary documentation for the extension is available at the [VS Code documentation website](https://code.visualstudio.com/docs/containers/overview). If something is unclear or does not ring true, tell us using "unhelpful documentation" link that you can find at the bottom of every page.
If something seems wrong with [the README file](README.md) or [the Docker extension wiki](https://github.com/microsoft/vscode-docker/wiki), please open an issue, or submit a PR with correction!
## Code
To contribute bug fixes, features, or design changes:
* Clone the repository locally and open in VS Code.
* Install [ESLint for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint).
* Open the terminal (<kbd>CTRL</kbd>+ <kbd>\`</kbd> by default) and run `npm install`.
* To build, open the Command Palette (<kbd>F1</kbd> by default) and type in `Tasks: Run Build Task`.
* Debug: press <kbd>F5</kbd> (by default) to start debugging the extension.
## Legal
Before we can accept your pull request you will need to sign a **Contribution License Agreement**. All you need to do is to submit a pull request, then the PR will get appropriately labelled (e.g. `cla-required`, `cla-norequired`, `cla-signed`, `cla-already-signed`). If you already signed the agreement we will continue with reviewing the PR, otherwise system will tell you how you can sign the CLA. Once you sign the CLA all future PR's will be labeled as `cla-signed`.