-
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
Add README for each project in repo #27561
Comments
I really wish you would keep the standard security text in the parent readme in each readme as well. If you're overriding all of this it's important to highlight the right way to report security bugs. |
Rather than copy parts of the main readme, we should add a link to it. e.g.
|
@JamesNK Good idea. I've updated the template in the issue with this. |
I can try. |
Hi folks! Adjusted the template based on some feedback from Pranav. To avoid repeatedly stating that users can run the Ditto for the test section. |
I don't think we should worry about duplicating small inline sample commands like those in https://github.com/dotnet/aspnetcore/blob/45d77afa717e26576c28ee97d3638ce25532d0ed/src/SignalR/README.md. Having to click links to see what the one-line build and test commands are is annoying. Linking to the top-level docs is great, but deduping stuff like one-line build and test commands should be a non-goal in my opinion. |
Feel free to mention me for an edit review. |
Part of #27380.
Let's improve the project-specific docs in the repo. For larger projects (Blazor, MVC, SignalR) the docs should contain information about the project's dependency, test setup, an overview of the folder structure, etc. For smaller projects, the doc should contain a description of the contents and what they might be useful for.
Below is a sample README to use when populating each project so the repo is consistent.
The text was updated successfully, but these errors were encountered: