review github files #6
Conversation
Reviewed the following files: - [x] Readme.md - [x] Contributing.md was created and points to the docs repo. - [x] Code_of_conduct.md was created and follows the docs repo. - [x] .gitignore Created for samples and projects. - [x] .github folder: created pull request template and codeowners file based on docs repository.
.github/CODEOWNERS
Outdated
|
|
||
| # More details are here: https://help.github.com/articles/about-codeowners/ | ||
|
|
||
| # The '*' pattern is global owners. |
CONTRIBUTING.md
Outdated
|
|
||
| Thank you for your interest in contributing to the .NET documentation! | ||
|
|
||
| This repository contains the samples used in the .NET documentation. The main repository for .NET documentation is the [.NET Docs repository](https://github.com/dotnet/docs). See the [Contributing Guide](https://github.com/dotnet/docs/tree/master/Contributing.md) for information on contributing samples and topics to the .NET documentation. |
There was a problem hiding this comment.
I think that this should mention something about opening issues in the .NET Docs repository,
README.md
Outdated
| @@ -3,7 +3,3 @@ | |||
| This repo contains work-in-progress documentation for .NET. To contribute, see the [Contributing Guide](https://github.com/dotnet/docs/blob/master/CONTRIBUTING.md) and the [issues list](https://github.com/dotnet/docs/issues). | |||
There was a problem hiding this comment.
This should be modified to reflect its actual contents. as in contributing.md. Instead of just the link to issues, also note that to see samples issues, filter by the Repo - Samples label.
.github/CODEOWNERS
Outdated
|
|
||
| # The '*' pattern is global owners. | ||
| # Not adding in this PR, but I'd like to try adding a global owner set with the entire team. | ||
| # One interpretation of their docs is that global owners are added only if not removed |
There was a problem hiding this comment.
Is that one interpretation, or is that what the docs say:
Unless a later match takes precedence,
@global-owner1 and @global-owner2 will be requested for
review when someone opens a pull request.
-
@global-owner1 @global-owner2
Also, "their" has no referent here; better "the GitHub docs"
And perhaps instead of "added", "notified"
There was a problem hiding this comment.
"their" would be the GitHub docs. I read through their docs and blog post on how CodeOwners works, and it wasn't clear if only the most local rule applies, or if all rules apply, Another bit of text made it sound like only the most local rule applies, unless there are also global rules and then the global rules + the most local rule applies.
So I want to learn more about how this feature works before we add that. 🤷♂️
There was a problem hiding this comment.
This looks good, @BillWagner. You can merge when you're ready.
README.md
Outdated
| This repo contains documentation for the .NET API Reference. | ||
|
|
||
| The main repository for .NET documentation is the [.NET Docs repository](https://github.com/dotnet/docs). See the [Contributing Guide](https://github.com/dotnet/docs/tree/master/Contributing.md) for information on updating .NET API reference documentation. | ||
| We are tracking all work for this repository using [.NET Docs repository issues](https://github.com/dotnet/docs/issues). You can apply the [Repo - dotnet-api-docs](https://github.com/dotnet/docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22%3Afile_folder%3A+Repo+-+dotnet-api-docs%222) label for issues that are scoped to this repository. You can also apply the [Repo - samples](https://github.com/dotnet/docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22%3Afile_folder%3A+Repo+-+samples%22) label for issues that concern sample code. |
There was a problem hiding this comment.
I don't think customers can apply labels. I think only we can.
external contributors likely can't apply labels.
Reviewed the following files: