Skip to content

Fix CG vulnerabilities #520

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

Draft
wants to merge 7 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 24 additions & 21 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,25 @@
To build and test you need LTS Node >= 6.12.0 and Npm 5.5.1 (we use lock files). You can download from [nodejs.org](https://nodejs.org)

## Build
```
$ npm install
$ npm run build

```sh
npm install
npm run build
```

## Test

You should test with node 4.x, 6.x and 8.x LTS. We recommend using nvm ([linux](https://github.com/creationix/nvm) / [windows](https://github.com/coreybutler/nvm-windows)).
You should test with node 6.x, 10.x and 16.x LTS. We recommend using nvm ([linux](https://github.com/creationix/nvm) / [windows](https://github.com/coreybutler/nvm-windows)).

To run units:

```
```sh
npm run units
```

To run all tests:

```
```sh
npm test
```

Expand All @@ -47,26 +47,27 @@ Create a [new issue](https://github.com/Microsoft/vsts-node-api/issues/new).
2. Create a fork in GitHub
3. Create a branch off the `master` branch. Name it something that makes sense, such as `issue-123` or `githubhandle-issue`. This makes it easy for everyone to figure out what the branch is used for. It also makes it easier to isolate your change from incoming changes from the origin.
4. Commit your changes and push your changes to GitHub
5. Create a pull request against the origin's `master` branch. [Learn more about pull requests](https://help.github.com/articles/using-pull-requests)
5. Create a pull request against the origin's `master` branch. [Learn more about pull requests](https://help.github.com/articles/using-pull-requests)

Before submitting a feature or substantial code contribution, please discuss it with the team and ensure it follows the product roadmap.
Before submitting a feature or substantial code contribution, please discuss it with the team and ensure it follows the product roadmap.

You might also read these two blogs posts on contributing code: [Open Source Contribution Etiquette](http://tirania.org/blog/archive/2010/Dec-31.html) by Miguel de Icaza and [Don't "Push" Your Pull Requests](http://www.igvita.com/2011/12/19/dont-push-your-pull-requests/) by Ilya Grigorik.

### Generated Code

Most of library is auto-generated and we will usually not accept pull requests on these files, but you can contribute to the non-generated aspects of the library. Right now, that includes:
* ./Api/VsoClient.ts
* ./Api/WebApi.ts
* ./Api/Interfaces/common/VsoBaseInterfaces.ts
* ./Api/handlers/*
* anything outside of ./Api

* ./Api/VsoClient.ts
* ./Api/WebApi.ts
* ./Api/Interfaces/common/VsoBaseInterfaces.ts
* ./Api/handlers/*
* anything outside of ./Api

### Commits

Please format commit messages as follows (based on this [excellent post](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)):

```
```text
Summarize change in 50 characters or less

Provide more detail after the first line. Leave one blank line below the
Expand Down Expand Up @@ -94,17 +95,19 @@ the PR.
## 2. Did you find a bug?

When logging a bug, please be sure to include the following:
* What version are you using?
* If at all possible, an *isolated* way to reproduce the behavior
* The behavior you expect to see, and the actual behavior
* Ensure it doesn't reproduce on the latest version or master
* An http trace from fiddler or charles if possible (the relevant parts)

* What version are you using?
* If at all possible, an *isolated* way to reproduce the behavior
* The behavior you expect to see, and the actual behavior
* Ensure it doesn't reproduce on the latest version or master
* An http trace from fiddler or charles if possible (the relevant parts)

## 3. Do you have a suggestion?

We also accept suggestions in the issue tracker.

In general, things we find useful when reviewing suggestions are:

* A description of the problem you're trying to solve
* An overview of the suggested solution
* Examples of how the suggestion would work in various places
Expand All @@ -114,4 +117,4 @@ In general, things we find useful when reviewing suggestions are:

## Contributor license agreement

You must sign a [Contributor License Agreement](https://cla.microsoft.com/) before submitting your pull request. To complete the Contributor License Agreement (CLA), you will need to submit a request via the [form](https://cla.microsoft.com/) and then electronically sign the CLA when you receive the email containing the link to the document. You need to sign the CLA only once to cover submission to any Microsoft OSS project.
You must sign a [Contributor License Agreement](https://cla.microsoft.com/) before submitting your pull request. To complete the Contributor License Agreement (CLA), you will need to submit a request via the [form](https://cla.microsoft.com/) and then electronically sign the CLA when you receive the email containing the link to the document. You need to sign the CLA only once to cover submission to any Microsoft OSS project.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ More detailed information for the endpoints of each API can be found at https://

## Running Samples

Pre-reqs: [Node >= 4.4.7 LTS](https://nodejs.org) and [typescript (tsc) >= 1.8](https://www.npmjs.com/package/typescript)
Pre-reqs: [Node >= 6.x LTS](https://nodejs.org).

Run `npm install` first

Expand Down
Loading