This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
Before you start, make sure you have read the Git branch setup instructions.
Our architecture documentation is a good starting point for a high-level overview of how the extension works.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
Please read through our Code of Conduct to this project.
Pull Requests should have a title that starts with a tag indicating the type of change. This helps us in maintaining a good commit history as well as better documentation when creating Release notes.
The convention that we follow is inspired from SemVer convention:
| Tag | What it conveys |
|---|---|
| feat | a commit of the type feat introduces a new feature in main or means completion of task towards a feature |
| fix | a commit of the type fix patches a bug or fixes a small known problem |
| chore | a commit of the type chore updates something in codebase without impacting any production code. eg: updating a grunt task etc. |
| refactor | a commit of type refactor specifies a code change that neither fixes a bug nor adds a feature but just refactors a portion of existing code |
Some examples of good PR titles are:
refactor: rename FooWidget to BarWidgetfeat(high-contrast-settings): add High Contrast toggle to settings panel