Update contribution info for docs repo (#25)

* Update contrib info

* Add email address
This commit is contained in:
Ryan Gregg 2018-06-26 16:38:55 -07:00 committed by GitHub
parent 84b673f54f
commit 21af3915cb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 61 additions and 4 deletions

19
.github/issue-template.md vendored Normal file
View File

@ -0,0 +1,19 @@
## Expected Behavior
## Actual Behavior
## Steps to Reproduce the Problem
1.
2.
3.
## Additional Info
<!--
You may also assign an issue via:
/assign @user
-->

7
.github/pull-request-template.md vendored Normal file
View File

@ -0,0 +1,7 @@
Fixes #(issue-number)
## Proposed Changes
*
*
*

View File

@ -1,5 +1,36 @@
# Contribution guidelines
# Contributing to Knative Documentation
So you want to hack on Knative Serving? Yay! Please refer to Knative
Serving's overall [contribution guidelines](community/CONTRIBUTING.md)
to find out how you can help.
**First off, thanks for taking the time to contribute!**
The following is a set of guidelines for contributing to Knative documentation.
These are just guidelines, not rules. Use your best judgment, and feel free to
propose changes to this document in a pull request.
## Before you get started
### Code of Conduct
Knative follows the [Knative Code of Conduct](code-of-conduct.md). By
participating, you are expected to uphold this code. Please report unacceptable
behavior to knative-code-of-conduct@googlegroups.com.
## Contributing to Documentation
### Reporting Documentation Issues
Knative uses github issues to track documentation issues and requests. If you
see a documentation issue, submit an issue using the following steps:
1. Check the [Knative docs issues list](https://github.com/knative/docs/issues)
as you might find out the issue is a duplicate.
2. Use the [included template for every new issue](https://github.com/knative/docs/issues/new).
When you create a bug report, include as many details as possible and include
suggested fixes to the issue.
Note that code issues should be filed against the individual Knative repositories,
while documentation issues should go in the `docs` repository.
### Submitting Documentation Pull Requests
If you're fixing an issue in the existing documentation, you should submit a
PR against the master branch.