Skip to content

Commit dad0dce

Browse files
author
damccorm
authored
Add detail to contribution doc (#230)
1 parent b87c28d commit dad0dce

1 file changed

Lines changed: 11 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Create a [new issue](https://github.com/Microsoft/vsts-node-api/issues/new).
4141

4242
## General contribution guide
4343

44-
> 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.
44+
> 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.
4545
4646
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.
4747
2. Create a fork in GitHub
@@ -53,6 +53,15 @@ Before submitting a feature or substantial code contribution, please discuss it
5353

5454
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.
5555

56+
### Generated Code
57+
58+
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:
59+
* ./Api/VsoClient.ts
60+
* ./Api/WebApi.ts
61+
* ./Api/Interfaces/common/VsoBaseInterfaces.ts
62+
* ./Api/handlers/*
63+
* anything outside of ./Api
64+
5665
### Commits
5766

5867
Please format commit messages as follows (based on this [excellent post](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)):
@@ -91,7 +100,7 @@ When logging a bug, please be sure to include the following:
91100
* Ensure it doesn't reproduce on the latest version or master
92101
* An http trace from fiddler or charles if possible (the relevant parts)
93102

94-
## 5. Do you have a suggestion?
103+
## 3. Do you have a suggestion?
95104

96105
We also accept suggestions in the issue tracker.
97106

0 commit comments

Comments
 (0)