Adding docs for dev env, build and tests for contributing #5370
Conversation
vhvb1989
requested review from
joshfree,
JonathanGiles,
jianghaolu,
conniey,
mssfang,
alzimmermsft and
srnagar
vhvb1989
force-pushed
the
adding-contributing-docs
branch
2 times, most recently
from
76e3dad to
e8538fc
Compare
CONTRIBUTING.md
Outdated
| # Ways to contribute |
There was a problem hiding this comment.
Nice work.
Consider ripping off this https://github.com/dotnet/corefx/blob/master/CONTRIBUTING.md and refactoring the doc into 2 sections - contributing information (coding styles, source structure, making pull requests, working with the team); and a separate Developer guide (how to enlist, build, run tests)
There was a problem hiding this comment.
to be clear, I'm OK merging this to get started and we can have subsequent PRs to add more to the document. This is certainly much better than our current contributing.md 😄
There was a problem hiding this comment.
ok. I have updated it to have 2 main sections. Let me know what you think.
I am pointing to the docs we already have in the Wiki. Probably we would prefer to have all docs in the repo itself instead of the wiki (or generate some static pages with Jekyll or something into github-pages instead of the simple github wiki)
Let me know what you think.
|
|
||
| ## Setting up a developer environment | ||
| - Install Java Development Kit 8 |
There was a problem hiding this comment.
I removed the link as per @JonathanGiles suggestion that we shouldn't tell people to use Oracle Java or OpenJDK , but just ask for JDK8.
Makes sense I think
vhvb1989
force-pushed
the
adding-contributing-docs
branch
from
e8538fc to
b13e7b3
Compare
preview
