-
Notifications
You must be signed in to change notification settings - Fork 10.1k
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
Conversation
src/Components/README.md
Outdated
## 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. |
There was a problem hiding this comment.
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
orbuild.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 thesrc/Components
directory, and runbuild.[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?
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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>
There was a problem hiding this 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.
bf9cbd3
to
c8da724
Compare
Hello @captainsafia! Because this pull request has the 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 (
|
Part of #27561.