mirror of https://github.com/knative/client.git
Update code-of-conduct, readme and contrib files (#1429)
* update docs * update docs * update docs
This commit is contained in:
parent
2e714510c5
commit
00269396cf
|
@ -0,0 +1,5 @@
|
||||||
|
# Contribution guidelines
|
||||||
|
|
||||||
|
So you want to hack on Knative Serving? Yay! Please refer to Knative's overall
|
||||||
|
[contribution guidelines](https://www.knative.dev/community/contributing/) to
|
||||||
|
find out how you can help.
|
18
README.md
18
README.md
|
@ -44,22 +44,12 @@ extend the `kn` CLI. For more information, have a look at:
|
||||||
- [User guide](docs/README.md)
|
- [User guide](docs/README.md)
|
||||||
- Installation - How to install `kn` and run on your machine
|
- Installation - How to install `kn` and run on your machine
|
||||||
- Examples - Use case based examples
|
- Examples - Use case based examples
|
||||||
- FAQ (_to come._)
|
|
||||||
- [Reference Manual](docs/cmd/kn.md) - all possible commands and options with
|
- [Reference Manual](docs/cmd/kn.md) - all possible commands and options with
|
||||||
usage examples
|
usage examples
|
||||||
|
|
||||||
|
Additionally you can visit [knative.dev](https://knative.dev) for more examples.
|
||||||
|
|
||||||
## Developers
|
## Developers
|
||||||
|
|
||||||
We love contributions! Please refer to
|
If you are interested in contributing, see [CONTRIBUTING.md](./CONTRIBUTING.md)
|
||||||
[CONTRIBUTING](https://knative.dev/contributing/) for more information on how to
|
and [DEVELOPMENT.md](docs/DEVELOPMENT.md).
|
||||||
best contributed to contribute to Knative.
|
|
||||||
|
|
||||||
For code contributions it as easy as picking an
|
|
||||||
[issue](https://github.com/knative/client/issues) (look out for
|
|
||||||
"kind/good-first-issue"), briefly comment that you would like to work on it,
|
|
||||||
code, test, code and finally submit a
|
|
||||||
[PR](https://github.com/knative/client/pulls) which will trigger the review
|
|
||||||
process.
|
|
||||||
|
|
||||||
More details on how to build and test can be found in the
|
|
||||||
[Developer guide](docs/DEVELOPMENT.md).
|
|
||||||
|
|
|
@ -0,0 +1,75 @@
|
||||||
|
# Contributor Covenant Code of Conduct
|
||||||
|
|
||||||
|
## Our Pledge
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|
Examples of unacceptable behavior by participants include:
|
||||||
|
|
||||||
|
- 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
|
||||||
|
address, without explicit permission
|
||||||
|
- Other conduct which could reasonably be considered inappropriate in a
|
||||||
|
professional setting
|
||||||
|
|
||||||
|
## Our Responsibilities
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
This Code of Conduct applies both within project spaces and in public spaces
|
||||||
|
when an individual is representing the project or its community. Examples of
|
||||||
|
representing a project or community include using an official project e-mail
|
||||||
|
address, posting via an official social media account, or acting as an appointed
|
||||||
|
representative at an online or offline event. Representation of a project may be
|
||||||
|
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.
|
||||||
|
|
||||||
|
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
|
||||||
|
members of the project's leadership.
|
||||||
|
|
||||||
|
## Attribution
|
||||||
|
|
||||||
|
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||||
|
version 1.4, available at
|
||||||
|
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
||||||
|
|
||||||
|
[homepage]: https://www.contributor-covenant.org
|
Loading…
Reference in New Issue