Skip to content

Commit 18c09e5

Browse files
authored
review github files (#6)
* review github files 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. * update per feedback. * wording change external contributors likely can't apply labels.
1 parent 63d91b7 commit 18c09e5

File tree

5 files changed

+36
-5
lines changed

5 files changed

+36
-5
lines changed

.github/CODEOWNERS

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Lines starting with '#' are comments.
2+
# Each line is a file pattern followed by one or more owners.
3+
4+
# More details are here: https://help.github.com/articles/about-codeowners/
5+
6+
# The '*' pattern is for global owners.
7+
# Not adding in this PR, but I'd like to try adding a global owner set with the entire team.
8+
# One interpretation of the GitHub docs is that global owners are added only if not removed
9+
# by a more local rule.
10+
11+
# Order is important. The last matching pattern has the most precedence.
12+
# The folders are ordered as follows:
13+
14+
# In each subsection folders are order first by depth, then alphabetically.
15+
# This should make it easy to add new rules without breaking existing ones.
16+

.github/PULL_REQUEST_TEMPLATE.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## Summary
2+
3+
Describe your changes here.
4+
5+
Fixes dotnet/docs#Issue_Number (if available)

CODE_OF_CONDUCT.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Code of Conduct
2+
3+
This project has adopted the code of conduct defined by the Contributor Covenant
4+
to clarify expected behavior in our community.
5+
For more information, see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).

CONTRIBUTING.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing to the .NET documentation!
4+
5+
This repository contains the API Reference .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 updating .NET API reference documentation.
6+
We are tracking all work for this repository using [.NET Docs repository issues](https://github.com/dotnet/docs/issues). You can select 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 to see issues that are scoped to this repository.

README.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
# .NET Docs
22

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).
3+
This repo contains documentation for the .NET API Reference.
4+
5+
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.
6+
We are tracking all work for this repository using [.NET Docs repository issues](https://github.com/dotnet/docs/issues). You can select 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 to see issues that are scoped to this repository. You can also select the [Repo - samples](https://github.com/dotnet/docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22%3Afile_folder%3A+Repo+-+samples%22) label to see issues that concern sample code.
47

5-
We welcome contributions to help us improve and complete the .NET docs. We anticipate that [Xamarin](http://developer.xamarin.com/api/root/classlib/), [Mono](http://docs.go-mono.com/?link=root%3a%2fclasslib) and [Unity](http://docs.unity3d.com/Manual/index.html) will also use this documentation.
68

7-
This project has adopted the code of conduct defined by the Contributor Covenant
8-
to clarify expected behavior in our community.
9-
For more information, see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).

0 commit comments

Comments
 (0)