knative
/
caching
mirror of https://github.com/knative/caching.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Format markdown (#226) 

Produced via:
  `prettier --write --prose-wrap=always $(find -name '*.md' | grep -v vendor | grep -v .github)`
/assign n3wscott vagababov
/cc n3wscott vagababov
This commit is contained in:
Matt Moore 2020-03-09 09:58:29 -07:00 committed by GitHub
parent b3e9ec7714
commit 435a8dc1b0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 57 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
DEVELOPMENT.md
View File

@ -1,16 +1,16 @@
# Development # Development
This doc explains how to setup a development environment so you can get started This doc explains how to setup a development environment so you can get started
[contributing](https://www.knative.dev/contributing/) [contributing](https://www.knative.dev/contributing/) to Knative `caching`. Also
to Knative `caching`. Also take a look at: take a look at:
* [The pull request workflow](https://knative.dev/community/contributing/reviewing/) - [The pull request workflow](https://knative.dev/community/contributing/reviewing/)
## Getting started ## Getting started
1. Create [a GitHub account](https://github.com/join) 1. Create [a GitHub account](https://github.com/join)
1. Setup [GitHub access via 1. Setup
SSH](https://help.github.com/articles/connecting-to-github-with-ssh/) [GitHub access via SSH](https://help.github.com/articles/connecting-to-github-with-ssh/)
1. Install [requirements](#requirements) 1. Install [requirements](#requirements)
1. Set up your [shell environment](#environment-setup) 1. Set up your [shell environment](#environment-setup)
1. [Create and checkout a repo fork](#checkout-your-fork) 1. [Create and checkout a repo fork](#checkout-your-fork)
@ -21,7 +21,8 @@ Before submitting a PR, see also [CONTRIBUTING.md](./CONTRIBUTING.md).
You must install these tools: You must install these tools:
1. [`go`](https://golang.org/doc/install): The language Knative `caching` is built in 1. [`go`](https://golang.org/doc/install): The language Knative `caching` is
built in
1. [`git`](https://help.github.com/articles/set-up-git/): For source control 1. [`git`](https://help.github.com/articles/set-up-git/): For source control
1. [`dep`](https://github.com/golang/dep): For managing external dependencies. 1. [`dep`](https://github.com/golang/dep): For managing external dependencies.
@ -30,9 +31,11 @@ You must install these tools:
To get started you'll need to set these environment variables (we recommend To get started you'll need to set these environment variables (we recommend
adding them to your `.bashrc`): adding them to your `.bashrc`):
1. `GOPATH`: If you don't have one, simply pick a directory and add `export GOPATH=...` 1. `GOPATH`: If you don't have one, simply pick a directory and add
`export GOPATH=...`
1. `$GOPATH/bin` on `PATH`: This is so that tooling installed via `go get` will work properly. 1. `$GOPATH/bin` on `PATH`: This is so that tooling installed via `go get` will
work properly.
`.bashrc` example: `.bashrc` example:
@ -43,25 +46,28 @@ export PATH="${PATH}:${GOPATH}/bin"
### Checkout your fork ### Checkout your fork
The Go tools require that you clone the repository to the `src/github.com/knative/caching` directory The Go tools require that you clone the repository to the
in your [`GOPATH`](https://github.com/golang/go/wiki/SettingGOPATH). `src/github.com/knative/caching` directory in your
[`GOPATH`](https://github.com/golang/go/wiki/SettingGOPATH).
To check out this repository: To check out this repository:
1. Create your own [fork of this repo](https://help.github.com/articles/fork-a-repo/) 1. Create your own
[fork of this repo](https://help.github.com/articles/fork-a-repo/)
1. Clone it to your machine: 1. Clone it to your machine:
```shell ```shell
mkdir -p ${GOPATH}/src/github.com/knative mkdir -p ${GOPATH}/src/github.com/knative
cd ${GOPATH}/src/github.com/knative cd ${GOPATH}/src/github.com/knative
git clone git@github.com:${YOUR_GITHUB_USERNAME}/caching.git git clone git@github.com:${YOUR_GITHUB_USERNAME}/caching.git
cd caching cd caching
git remote add upstream git@github.com:knative/caching.git git remote add upstream git@github.com:knative/caching.git
git remote set-url --push upstream no_push git remote set-url --push upstream no_push
``` ```
_Adding the `upstream` remote sets you up nicely for regularly [syncing your _Adding the `upstream` remote sets you up nicely for regularly
fork](https://help.github.com/articles/syncing-a-fork/)._ [syncing your fork](https://help.github.com/articles/syncing-a-fork/)._
Once you reach this point you are ready to do a full build and deploy as described below. Once you reach this point you are ready to do a full build and deploy as
described below.

2
README.md
View File

@ -4,7 +4,7 @@
[![Go Report Card](https://goreportcard.com/badge/knative/caching)](https://goreportcard.com/report/knative/caching) [![Go Report Card](https://goreportcard.com/badge/knative/caching)](https://goreportcard.com/report/knative/caching)
Knative `caching` defines resources that can be used to express a desire to Knative `caching` defines resources that can be used to express a desire to
cache things. These are **just** API definitions for caching custom resources cache things. These are **just** API definitions for caching custom resources
plugins, it does not include an implementation of this API. plugins, it does not include an implementation of this API.
To learn more about Knative, please visit our To learn more about Knative, please visit our

57
code-of-conduct.md
View File

@ -5,30 +5,30 @@
In the interest of fostering an open and welcoming environment, we as In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience, size, disability, ethnicity, gender identity and expression, level of
education, socio-economic status, nationality, personal appearance, race, experience, education, socio-economic status, nationality, personal appearance,
religion, or sexual identity and orientation. race, religion, or sexual identity and orientation.
## Our Standards ## Our Standards
Examples of behavior that contributes to creating a positive environment Examples of behavior that contributes to creating a positive environment
include: include:
* Using welcoming and inclusive language - Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences - Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism - Gracefully accepting constructive criticism
* Focusing on what is best for the community - Focusing on what is best for the community
* Showing empathy towards other community members - Showing empathy towards other community members
Examples of unacceptable behavior by participants include: Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or - The use of sexualized language or imagery and unwelcome sexual attention or
advances advances
* Trolling, insulting/derogatory comments, and personal or political attacks - Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment - Public or private harassment
* Publishing others' private information, such as a physical or electronic - Publishing others' private information, such as a physical or electronic
address, without explicit permission address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a - Other conduct which could reasonably be considered inappropriate in a
professional setting professional setting
## Our Responsibilities ## Our Responsibilities
@ -37,11 +37,11 @@ Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior. response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or Project maintainers have the right and responsibility to remove, edit, or reject
reject comments, commits, code, wiki edits, issues, and other contributions comments, commits, code, wiki edits, issues, and other contributions that are
that are not aligned to this Code of Conduct, or to ban temporarily or not aligned to this Code of Conduct, or to ban temporarily or permanently any
permanently any contributor for other behaviors that they deem inappropriate, contributor for other behaviors that they deem inappropriate, threatening,
threatening, offensive, or harmful. offensive, or harmful.
## Scope ## Scope
@ -54,14 +54,13 @@ further defined and clarified by project maintainers.
## Enforcement ## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior Instances of abusive, harassing, or otherwise unacceptable behavior may be
may be reported by contacting the project team at reported by contacting the project team at
knative-code-of-conduct@googlegroups.com. All complaints will be reviewed knative-code-of-conduct@googlegroups.com. All complaints will be reviewed and
and investigated and will result in a response that is deemed investigated and will result in a response that is deemed necessary and
necessary and appropriate to the circumstances. The project team is appropriate to the circumstances. The project team is obligated to maintain
obligated to maintain confidentiality with regard to the reporter of confidentiality with regard to the reporter of an incident. Further details of
an incident. Further details of specific enforcement policies may be specific enforcement policies may be posted separately.
posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other faith may face temporary or permanent repercussions as determined by other
@ -69,8 +68,8 @@ members of the project's leadership.
## Attribution ## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, This Code of Conduct is adapted from the [Contributor Covenant][homepage],
available [here](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html). version 1.4, available
[here](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html).
[homepage]: https://www.contributor-covenant.org [homepage]: https://www.contributor-covenant.org