forked from tektoncd/experimental
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add basic docs as specified at https://github.com/tektoncd/community/blob/master/process.md#project-requirements. Note that a lot of the specifics about contributing and development hinge on us fleshing out support for experimental projects, something partially captured in tektoncd/plumbing#3.
- Loading branch information
1 parent
a8b03db
commit 601d165
Showing
6 changed files
with
144 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
name: Issue Template | ||
about: Template for both bug reports and feature requests | ||
--- | ||
|
||
# Expected Behavior | ||
|
||
<!-- Please clearly explain which experimental project this applies to (or if this applies to all projects) --> | ||
|
||
# Actual Behavior | ||
|
||
# Steps to Reproduce the Problem | ||
|
||
1. | ||
2. | ||
3. | ||
|
||
# Additional Info |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
<!-- 🎉🎉🎉 Thank you for the PR!!! 🎉🎉🎉 --> | ||
|
||
# Changes | ||
|
||
<!-- Describe your changes here- ideally you can get that description straight from | ||
your descriptive commit message(s)! --> | ||
|
||
# Submitter Checklist | ||
|
||
These are the criteria that every PR should meet, please check them off as you | ||
review them: | ||
|
||
- [ ] Includes [docs](https://github.com/tektoncd/community/blob/master/standards.md#principles) (if user facing) | ||
- [ ] Commit messages follow [commit message best practices](https://github.com/tektoncd/community/blob/master/standards.md#commit-messages) | ||
|
||
_See [the contribution guide](https://github.com/tektoncd/experimental/blob/master/CONTRIBUTING.md) | ||
for more details._ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# Contributing to the experimental repo | ||
|
||
Thank you for your interest in contributing! | ||
|
||
This doc is about how to contribute to this repo specifically. For how to | ||
contribute to tektoncd projects in general, see [the overview in our README](README.md) | ||
and the individual `CONTRIBUTING.md` files in each respective project. | ||
|
||
**All contributors must comply with | ||
[the code of conduct](./code-of-conduct.md).** | ||
|
||
PRs are welcome, and will follow | ||
[the tektoncd pull request process](https://github.com/tektoncd/community/blob/master/process.md#pull-request-process). | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Developing | ||
|
||
See [CONTRIBUTING.md](CONTRIBUTING.md) and look in each project's folder for | ||
its specific `DEVELOPMENT.md`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,16 @@ | ||
# experimental | ||
Experimental Tekton Components | ||
# Experimental Tekton Components | ||
|
||
Welcome to the Tekton Experimental 🧪 components repo! | ||
|
||
Tekton projects may start off in this repo so community members can | ||
collaborate before | ||
[promoting the project to a top level repo](https://github.com/tektoncd/community/blob/master/process.md#promotion-from-experimental-to-top-level-repo). | ||
|
||
The setup for this repo is a work in progress (https://github.com/tektoncd/plumbing/issues/3) | ||
but the goal is that: | ||
|
||
- Each project will have its own folder | ||
- Each folder will have it's own [OWNERS](https://github.com/tektoncd/community/blob/master/process.md#OWNERS) | ||
and [pull request automation](https://github.com/tektoncd/community/blob/master/process.md#reviews) | ||
|
||
See also [CONTRIBUTING.md](CONTRIBUTING.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
[email protected]. 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 |