Skip to content
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.

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

Update README for Components directory #27650

Merged
4 commits merged into from
Nov 13, 2020
Merged

Update README for Components directory #27650

4 commits merged into from
Nov 13, 2020

Conversation

captainsafia
Copy link
Member

Part of #27561.

@captainsafia captainsafia requested review from SteveSandersonMS and a team as code owners November 9, 2020 19:23
@ghost ghost added the area-blazor Includes: Blazor, Razor Components label Nov 9, 2020
src/Components/README.md Outdated Show resolved Hide resolved
src/Components/README.md Show resolved Hide resolved
## Getting Started
### Build

This project takes a dependency on MVC and SignalR packages. In order to build this project and its dependencies, run the following command inside this directory.
Copy link
Contributor

Choose a reason for hiding this comment

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

What do you think about adding a general section to BuildFromSources.md that talks about how to build "sub-folders" and linking from here?

Each directory under src represents a feature area of ASP.NET Core. We provide convenience scripts build.sh or build.cmd inside these directories that let you build and test only this feature. For instance, if you were interested in contributing to Blazor, navigate to the src/Components directory, and run build.[cmd|sh] there to build all the projects and it's dependencies.

Then we link to these instructions from each of these docs. so we're not repeating ourselves?

Copy link
Contributor

Choose a reason for hiding this comment

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

This project takes a dependency on MVC and SignalR packages.

Ehh, these things are easy to go out of sync and don't really help the user much. Could we not list this here?

Copy link
Member Author

Choose a reason for hiding this comment

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

Then we link to these instructions from each of these docs. so we're not repeating ourselves?

Good insight. I think we can probably address this for all the projects in one go as part of #27631.

Ehh, these things are easy to go out of sync and don't really help the user much. Could we not list this here?

I've removed it.

Co-authored-by: Pranav K <prkrishn@hotmail.com>
Copy link
Member

@SteveSandersonMS SteveSandersonMS left a comment

Choose a reason for hiding this comment

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

Looks good to me! I'll assume you and @pranavkm will figure out the details of accounting for his feedback.

@captainsafia captainsafia requested a review from dougbu as a code owner November 11, 2020 22:23
@ghost
Copy link

ghost commented Nov 13, 2020

Hello @captainsafia!

Because this pull request has the auto-merge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

@ghost ghost merged commit 45540f7 into master Nov 13, 2020
@ghost ghost deleted the safia/project-readmes branch November 13, 2020 22:35
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-blazor Includes: Blazor, Razor Components
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants