Skip to content

Add detail to contribution doc #230

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.

Sign up for GitHub

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
damccorm merged 1 commit into from
Sep 27, 2018
Merged

Add detail to contribution doc #230

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 11 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Create a [new issue](https://github.com/Microsoft/vsts-node-api/issues/new).

## General contribution guide

> Keep in mind: most of the code in this repository is auto-generated, but you can contribute to the non-generated aspects of the library.
> Keep in mind: most of the code in this repository is auto-generated, but you can contribute to the non-generated aspects of the library.

1. Unless it is a trivial change, make sure that there is a corresponding issue for your change first. If there is none, create one.
2. Create a fork in GitHub
Expand All @@ -53,6 +53,15 @@ Before submitting a feature or substantial code contribution, please discuss it

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

### 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)):
Expand Down Expand Up @@ -91,7 +100,7 @@ When logging a bug, please be sure to include the following:
* Ensure it doesn't reproduce on the latest version or master
* An http trace from fiddler or charles if possible (the relevant parts)

## 5. Do you have a suggestion?
## 3. Do you have a suggestion?

We also accept suggestions in the issue tracker.

Expand Down