"How to build and run the latest" - Moving towards an explicit explanation....
See original GitHub issueIssue
Obviously my position approaching this, is an outsider looking in. One looking to make contributions to this project would require a ramp-up, of which starts with How to build and run the latest.
The combination of the four steps that are outlined and how I (an outsider) perceive them, fails to produce a working dev environment. Of which, I would attribute to implicit explanations.
Breakdown
Prerequisites
- Though to one it might seem obvious, things like denoting vs 2017 is a requirement is of value to others.
Step 1: Get the SDK for your platform from dotnet/cli
- More explanation is needed as to what version is required and how to maintain version compatibility moving forward.
- Do we need 1.0.x, 1.1.x, 2.x? Do we need RC or Alpha?
Step 2: Clone this repository to your local machine
- Simple enough on the surface but details on branching strategies and expectations would go a long way.
- For example, as of the date I am writing this, it appears the default branch is rel/vs2017/post-rtw.
- If the expectation is for contributes to branch off of branch-x, explicit explanation would go a long way.
Step 3: Run the setup script
- Again, simple enough but results in an unclear outcome. See next step…
Step 4: That’s it! Now you can run dotnet new3
- Running through the steps as I have viewed them, has resulted in the above.
dotnet new --help
produces expected output whiledotnet new3 --help
does not.
Solution
It would be of value to open up the conversation early about the process I or any other potential new contributor goes through when trying to ramp up the knowledge set needed to contribute to this project. Personally, I would be more then willing to document the knowledge gained as I progress through this process. Be that via the wiki or readme.
Issue Analytics
- State:
- Created 7 years ago
- Comments:12 (12 by maintainers)
Top GitHub Comments
Sounds good. Thanks @chad-ramos for writing up the detailed instructions!
@mlorbetske - With #417 being merged, any issues with closing this “Issue”?