Skip to content

fix instructions for contributing to lib.d.ts#5912

Merged
mhegazy merged 2 commits intomicrosoft:masterfrom
sparecycles:fix-contributing-instructions
Dec 3, 2015
Merged

fix instructions for contributing to lib.d.ts#5912
mhegazy merged 2 commits intomicrosoft:masterfrom
sparecycles:fix-contributing-instructions

Conversation

@sparecycles
Copy link
Copy Markdown
Contributor

@sparecycles sparecycles commented Dec 3, 2015

@sparecycles
Copy link
Copy Markdown
Contributor Author

sparecycles commented Dec 3, 2015

Tried running jake lib in the #5461 commit, didn't work then either 😉

mhegazy
mhegazy reviewed Dec 3, 2015
View reviewed changes
Comment thread CONTRIBUTING.md Outdated
Copy link
Copy Markdown
Contributor

@mhegazy mhegazy Dec 3, 2015

Choose a reason for hiding this comment

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

no, it is lib that builds the library files.

jake lib -> src\lib\*.d.ts combine them into built\local\lib.*.d.ts
jake LKG -> jake local with debug=false, copy built\local\* to lib\* in preparation of publishing an npm

so files in \lib\ should not be touched by hand, only through jake LKG

@mhegazy
Copy link
Copy Markdown
Contributor

mhegazy commented Dec 3, 2015

Tried running jake lib in the #5461 commit, didn't work then either 😉

how is that? what did you see? any errors?

@sparecycles
Copy link
Copy Markdown
Contributor Author

sparecycles commented Dec 3, 2015

You don't even need jake lib to update the built/local data, just running jake after changing src/lib files updates that fine (as I expect running jake with no arguments to do).

But, when I run jake lib I don't think it's out of scope to assume lib would be updated.

In the instructions: "To build the library files" obviously means the files in lib/ (except it doesn't). The README in lib/ says these files are not meant to be updated by hand, and changes should be made in src/ but nowhere is it documented that the command is jake LKG.

Can you not see how this is confusing?

@mhegazy
Copy link
Copy Markdown
Contributor

mhegazy commented Dec 3, 2015

i see. well in my defense, \lib was called \bin and that was less confusing..

Any how, so we can make it jake local or just 'jake`, how about that?

@sparecycles
Copy link
Copy Markdown
Contributor Author

sparecycles commented Dec 3, 2015

(hmm... musing) perhaps /bootstrap ( or /bs ? ) would be a better name?

@mhegazy
Copy link
Copy Markdown
Contributor

mhegazy commented Dec 3, 2015

looks good. thanks!

mhegazy added a commit that referenced this pull request Dec 3, 2015
@mhegazy
Merge pull request #5912 from sparecycles/fix-contributing-instructions
3edc9c9 
fix instructions for contributing to lib.d.ts
@mhegazy mhegazy merged commit 3edc9c9 into microsoft:master Dec 3, 2015
@microsoft microsoft locked and limited conversation to collaborators Jun 19, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@sparecycles @mhegazy @msftclas