-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Document contribution to the code along with coding standards #321
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document contribution to the code along with coding standards #321
Conversation
Archive of 0.7.0
* 'master' of https://github.com/Microsoft/vscode-python: Fixes #56 list all environments (#219) Fixes #57 Disable activation on debugging (#220) Fixes #26 Do not run linters when linters are disabled (#222)
* upstream/master: Fix typo in README.md (#252) Disable linter without workspaces (#241)
* upstream/master: Fix feedback service (#246) Fix django context initializer (#248) disable generation of tags file upon extension load (#264)
* upstream/master: Resolve pythonPath before comparing it to shebang (#273)
* upstream/master:
Fixes #22 to Detect anaconda from known locations (#221)
Use workspaceFolder token instead of workspaceRoot (#267)
Fix registry lookup response (#224)
Fix issues when running without debugging and debugged code terminates (#249)
* upstream/master: Fix debugging tests (#304)
* upstream/master: Remove jupyter functionality in favor of Jupyter extension (#302) Drop Python 2 URLs (#307)
* upstream/master: Remove setting python.formatting.formatOnSave in favor of the vs code setting (#312)
* upstream/master: Remove setting linting.lintOnTextChange as it was never implemented (#315)
@brettcannon took the liberty of including stack overflow in there as well. However you might want to review that bit, not sure whether we need to include that or if its worded correctly. |
Did you mean to close this without merging? |
Realized after the PR that you're working on CONTRIBUTING.md. Renamed to CONTRIBUTIN_TO_THE_CODE.md (instructions to building and contributing to source with coding guidelines) |
Removed stuff related to stack overflow, etc. Purely focused on code contribution. |
I'm working on a part of |
Ok, once you're done, I'll update the CONTRIBUTING.md and then we can re-visit this PR. |
* upstream/master: Fix travis build error (#326)
* upstream/master: add new npm deps with improved gulp for dev (#328)
* upstream/master: Update version of inversify package (#329)
* upstream/master: Document our dev process (#330)
@brettcannon all good, this is now ready for review.
|
@brettcannon , will add Mikhail as a reviewer to this instead. |
👍 |
@@ -0,0 +1,43 @@ | |||
## Coding guidelines for TypeScript |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are these taken from somewhere? I.e. is there a link to provide that mirrors these so that we don't have to maintain our own style guide? Or maybe one to fall back on when this style guide doesn't answer a question?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://github.com/Microsoft/TypeScript/wiki/Coding-guidelines
Will update to reference above
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@brettcannon updated, let me know if the updated version is good.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep, if the current style is divergent from the TS style guide then it LGTM.
CONTRIBUTING.md
Outdated
4. Visual Studio Code | ||
5. Following VS Code extensions: | ||
* [TSLint](https://marketplace.visualstudio.com/items?itemName=eg2.tslint) | ||
* [EditorConfig fot VS Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"fot" -> "for"
CONTRIBUTING.md
Outdated
### Coding Standards | ||
|
||
Information on our coding standards can be found [here](https://github.com/Microsoft/vscode-python/blob/master/CODING_STANDARDS.md). | ||
We have a per-commit hook to ensure the code committed will adhere to the above coding standards. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"per-" -> "pre-"
* upstream/master: Document contribution to the code along with coding standards (#321)
Fixes #320