mirror of https://github.com/knative/caching.git
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
GitHub
parent
b3e9ec7714
commit
435a8dc1b0
|
|
@ -1,16 +1,16 @@
|
|||
# Development
|
||||
|
||||
This doc explains how to setup a development environment so you can get started
|
||||
[contributing](https://www.knative.dev/contributing/)
|
||||
to Knative `caching`. Also take a look at:
|
||||
[contributing](https://www.knative.dev/contributing/) to Knative `caching`. Also
|
||||
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
|
||||
|
||||
1. Create [a GitHub account](https://github.com/join)
|
||||
1. Setup [GitHub access via
|
||||
SSH](https://help.github.com/articles/connecting-to-github-with-ssh/)
|
||||
1. Setup
|
||||
[GitHub access via SSH](https://help.github.com/articles/connecting-to-github-with-ssh/)
|
||||
1. Install [requirements](#requirements)
|
||||
1. Set up your [shell environment](#environment-setup)
|
||||
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:
|
||||
|
||||
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. [`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
|
||||
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:
|
||||
|
||||
|
|
@ -43,25 +46,28 @@ export PATH="${PATH}:${GOPATH}/bin"
|
|||
|
||||
### Checkout your fork
|
||||
|
||||
The Go tools require that you clone the repository to the `src/github.com/knative/caching` directory
|
||||
in your [`GOPATH`](https://github.com/golang/go/wiki/SettingGOPATH).
|
||||
The Go tools require that you clone the repository to the
|
||||
`src/github.com/knative/caching` directory in your
|
||||
[`GOPATH`](https://github.com/golang/go/wiki/SettingGOPATH).
|
||||
|
||||
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:
|
||||
|
||||
```shell
|
||||
mkdir -p ${GOPATH}/src/github.com/knative
|
||||
cd ${GOPATH}/src/github.com/knative
|
||||
git clone git@github.com:${YOUR_GITHUB_USERNAME}/caching.git
|
||||
cd caching
|
||||
git remote add upstream git@github.com:knative/caching.git
|
||||
git remote set-url --push upstream no_push
|
||||
```
|
||||
```shell
|
||||
mkdir -p ${GOPATH}/src/github.com/knative
|
||||
cd ${GOPATH}/src/github.com/knative
|
||||
git clone git@github.com:${YOUR_GITHUB_USERNAME}/caching.git
|
||||
cd caching
|
||||
git remote add upstream git@github.com:knative/caching.git
|
||||
git remote set-url --push upstream no_push
|
||||
```
|
||||
|
||||
_Adding the `upstream` remote sets you up nicely for regularly [syncing your
|
||||
fork](https://help.github.com/articles/syncing-a-fork/)._
|
||||
_Adding the `upstream` remote sets you up nicely for regularly
|
||||
[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.
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
[](https://goreportcard.com/report/knative/caching)
|
||||
|
||||
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.
|
||||
|
||||
To learn more about Knative, please visit our
|
||||
|
|
|
|||
|
|
@ -5,30 +5,30 @@
|
|||
In the interest of fostering an open and welcoming environment, we as
|
||||
contributors and maintainers pledge to making participation in our project and
|
||||
our community a harassment-free experience for everyone, regardless of age, body
|
||||
size, disability, ethnicity, gender identity and expression, level of experience,
|
||||
education, socio-economic status, nationality, personal appearance, race,
|
||||
religion, or sexual identity and orientation.
|
||||
size, disability, ethnicity, gender identity and expression, level of
|
||||
experience, education, socio-economic status, nationality, personal appearance,
|
||||
race, religion, or sexual identity and orientation.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment
|
||||
include:
|
||||
|
||||
* Using welcoming and inclusive language
|
||||
* Being respectful of differing viewpoints and experiences
|
||||
* Gracefully accepting constructive criticism
|
||||
* Focusing on what is best for the community
|
||||
* Showing empathy towards other community members
|
||||
- Using welcoming and inclusive language
|
||||
- Being respectful of differing viewpoints and experiences
|
||||
- Gracefully accepting constructive criticism
|
||||
- Focusing on what is best for the community
|
||||
- Showing empathy towards other community members
|
||||
|
||||
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
|
||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or electronic
|
||||
- Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
- Public or private harassment
|
||||
- Publishing others' private information, such as a physical or electronic
|
||||
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
|
||||
|
||||
## 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
|
||||
response to any instances of unacceptable behavior.
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, or
|
||||
reject comments, commits, code, wiki edits, issues, and other contributions
|
||||
that are not aligned to this Code of Conduct, or to ban temporarily or
|
||||
permanently any contributor for other behaviors that they deem inappropriate,
|
||||
threatening, offensive, or harmful.
|
||||
Project maintainers have the right and responsibility to remove, edit, or reject
|
||||
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||
not aligned to this Code of Conduct, or to ban temporarily or permanently any
|
||||
contributor for other behaviors that they deem inappropriate, threatening,
|
||||
offensive, or harmful.
|
||||
|
||||
## Scope
|
||||
|
||||
|
|
@ -54,14 +54,13 @@ further defined and clarified by project maintainers.
|
|||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior
|
||||
may be reported by contacting the project team at
|
||||
knative-code-of-conduct@googlegroups.com. All complaints will be reviewed
|
||||
and investigated and will result in a response that is deemed
|
||||
necessary and appropriate to the circumstances. The project team is
|
||||
obligated to maintain confidentiality with regard to the reporter of
|
||||
an incident. Further details of specific enforcement policies may be
|
||||
posted separately.
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported by contacting the project team at
|
||||
knative-code-of-conduct@googlegroups.com. All complaints will be reviewed and
|
||||
investigated and will result in a response that is deemed necessary and
|
||||
appropriate to the circumstances. The project team is obligated to maintain
|
||||
confidentiality with regard to the reporter of an incident. Further details of
|
||||
specific enforcement policies may be posted separately.
|
||||
|
||||
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
|
||||
|
|
@ -69,8 +68,8 @@ members of the project's leadership.
|
|||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
||||
available [here](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html).
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||
version 1.4, available
|
||||
[here](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html).
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue