external/vscode-xml
1
0
Fork 1
Code Issues 1 Pull requests Projects Releases Wiki Activity

chore: update the guide to reflect the move from the TrueCommerce organization

Browse source
This commit is contained in:
Josh Johnson 2016-12-19 21:13:59 -05:00
parent ee6a49165d
commit da4400d333
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
CONTRIBUTING.md
View file

@ -3,7 +3,11 @@ Thanks for helping out! This guide provides some guidelines on coding styles and
Keep in mind that these are guidelines, not rules. Use your best judgement and feel free to make suggestions! Keep in mind that these are guidelines, not rules. Use your best judgement and feel free to make suggestions!
## Workflow ## Workflow
**Please read the [TrueCommerce organization's workflow documentation](https://github.com/TrueCommerce/Meta/wiki/workflow#truecommerce-workflow) before getting started.** Please use the follow general workflow when making contributions to the code:
1. Fork the repository.
2. Create a feature branch or commit directly to the `develop` branch.
3. Create a pull request to request that your commits be merged to the `develop` branch of the `vscode-xml` repository. PRs submitted to the `master` branch will not be considered.
## Building the Extension ## Building the Extension
@ -11,8 +15,6 @@ Keep in mind that these are guidelines, not rules. Use your best judgement and f
2. Run the `build` task in VS Code (`CTRL + SHIFT + B`) or start extension debugging (`F5`), which will run the `build` task for you. 2. Run the `build` task in VS Code (`CTRL + SHIFT + B`) or start extension debugging (`F5`), which will run the `build` task for you.
## Style Guide ## Style Guide
In short, favor clean, maintainable code over code that "just works".
### Imports ### Imports
To keep *.ts files from getting too cluttered, use a namespace alias when pulling in more than 4 or 5 objects. As a general rule, always import the `vscode` namespace using the `vsc` alias for consistency. To keep *.ts files from getting too cluttered, use a namespace alias when pulling in more than 4 or 5 objects. As a general rule, always import the `vscode` namespace using the `vsc` alias for consistency.