Skip to content

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

Merged
merged 38 commits into from
Dec 1, 2017

Conversation

DonJayamanne
Copy link

Fixes #320

  • Updated gulp.js to incrementally run the linter in watch mode
  • Updated CONTRIBUTING.md with information on creating issues and contributing to code
  • Added coding guidelines

octref and others added 24 commits November 3, 2017 13:11
* '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)
@DonJayamanne
Copy link
Author

@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.

@brettcannon
Copy link
Member

Did you mean to close this without merging?

@DonJayamanne DonJayamanne reopened this Nov 29, 2017
@DonJayamanne DonJayamanne changed the title Update CONTRIBUTING.md along with coding standards Document contribution to the code along with coding standards Nov 29, 2017
@DonJayamanne
Copy link
Author

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)

@DonJayamanne
Copy link
Author

Removed stuff related to stack overflow, etc. Purely focused on code contribution.

@brettcannon
Copy link
Member

I'm working on a part of CONTRIBUTING.md, not the whole thing, so no need to have a separate file.

@DonJayamanne
Copy link
Author

Ok, once you're done, I'll update the CONTRIBUTING.md and then we can re-visit this PR.

@DonJayamanne
Copy link
Author

@brettcannon all good, this is now ready for review.

  • Typescript coding standards
  • Updated dev guidelines
  • Updated travis to use latest node (the version required by vscode)
  • Updated build tools (gulp, improved dev experience)

@DonJayamanne
Copy link
Author

DonJayamanne commented Dec 1, 2017

@brettcannon , will add Mikhail as a reviewer to this instead.

@DonJayamanne DonJayamanne requested review from MikhailArkhipov and removed request for brettcannon December 1, 2017 18:33
@MikhailArkhipov
Copy link

👍

@@ -0,0 +1,43 @@
## Coding guidelines for TypeScript
Copy link
Member

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?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Author

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.

Copy link
Member

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)
Copy link
Member

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"per-" -> "pre-"

@DonJayamanne DonJayamanne merged commit 5430b5e into microsoft:master Dec 1, 2017
@DonJayamanne DonJayamanne deleted the UpdateContribution branch December 12, 2017 21:21
DonJayamanne added a commit that referenced this pull request Dec 14, 2017
* upstream/master:
  Document contribution to the code along with coding standards (#321)
@lock lock bot locked as resolved and limited conversation to collaborators Jul 31, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update CONTRIBUTING.md
4 participants