Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Overall update and cleanup. #52

Merged
merged 2 commits into from Mar 27, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
34 changes: 24 additions & 10 deletions CONTRIBUTING.md
Expand Up @@ -48,7 +48,8 @@ permission to use and redistribute your contributions as part of the project.
Any substantial design deserves a design document. Design documents are written with Google Docs and
should be shared with the community by adding the doc to our [Team Drive](https://drive.google.com/corp/drive/u/0/folders/0AIS5p3eW9BCtUk9PVA)
and sending a note to the appropriate working group to let people know the doc is there. To get write access
to the drive, you'll need to be a [member](ROLES.md#member) of the Istio organization.
to the drive, you'll need to be a [member](ROLES.md#member) of the Istio organization, but anybody can read and
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

anybody->anyone

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to the dictionary, these are interchangeable terms, so leaving as-is.

comment existing docs.

We have a common [design document template](https://docs.google.com/document/d/1cpolPNH_RtSobUjTkXyyxsCJT7EKD8fGiN2TgYLeJu8/edit#heading=h.7zgnj8bwqfld).
Just open the template and select "Make Copy" from the File menu in order to bootstrap your document.
Expand Down Expand Up @@ -82,9 +83,11 @@ implementation in the issue.
- Once the major technical issues are resolved and agreed upon, post a note to the working group's mailing
list with the design decision and the general execution plan.

- Submit PRs to istio/istio with your code changes.
- Submit PRs to [istio/istio](https://github.com/istio/istio) with your code changes.

- Submit PRs to istio/istio.github.io with documentation for your feature, including usage examples when possible.
- Submit PRs to [istio/istio.github.io](https://github.com/istio/istio.github.io) with
documentation for your feature, including usage examples when possible. See [here](https://istio.io/about/contribute/)
to learn how to write docs for istio.io.

> Note that we prefer bite-sized PRs instead of giant monster PRs. It's therefore preferable if you
can introduce large features in smaller reviewable changes that build on top of one another.
Expand All @@ -108,14 +111,20 @@ interest in working on it. This helps other people know that the issue is
active, and hopefully prevents duplicated efforts.

To submit a proposed change:

- Fork the affected repository.

- Create a new branch for your changes.

- Develop the code/fix.

- Add new test cases. In the case of a bug fix, the tests should fail
without your code changes. For new features try to cover as many
variants as reasonably possible.

- Modify the documentation as necessary.
- Verify the entire CI process (building and testing) work.

- Verify the entire CI process (building and testing) works.

While there may be exceptions, the general rule is that all PRs should
be 100% complete - meaning they should include all test cases and documentation
Expand All @@ -126,16 +135,21 @@ When ready, if you have not already done so, sign a
the PR.

See [Reviewing and Merging Pull Requests for Istio](REVIEWING.md) for the PR review and
merge process that is used by the maintainers of the project.
merge process that we use.

## Issues

GitHub issues can be used to report bugs or submit feature requests.
GitHub issues can be used to report bugs or submit feature requests. If you're an Istio user, please
report bugs [here](https://github.com/istio/issues/issues). If you're a contributor to the Istio project,
please submit bugs [here](https://github.com/istio/istio/issues) instead.

When reporting a bug please include the following key pieces of information:
- the version of the project you were using (e.g. version number,
git commit, ...)
- operating system you are using
- the exact, minimal, steps needed to reproduce the issue.

- The version of the project you were using (e.g. version number,
or git commit)

- Operating system you are using.

- The exact, minimal, steps needed to reproduce the issue.
Submitting a 5 line script will get a much faster response from the team
than one that's hundreds of lines long.
22 changes: 11 additions & 11 deletions FEATURE-LIFECYCLE.md
Expand Up @@ -26,13 +26,6 @@ of this information at [Feature Lifecycle Checklist](FEATURE-LIFECYCLE-CHECKLIST
<td>Code is well tested. The feature is safe for production use.</td>
<td>Code is well tested and stable. Safe for widespread deployment in production.</td>
</tr>
<tr>
<td>Support</td>
<td>None</td>
<td>No guarantees on backward compatibility. The feature may be dropped at any time without notice.</td>
<td>The overall feature will not be dropped, though details may change.</td>
<td>The feature will appear in released software for many subsequent versions.</td>
</tr>
<tr>
<td>Performance</td>
<td>Unknown</td>
Expand All @@ -41,11 +34,18 @@ of this information at [Feature Lifecycle Checklist](FEATURE-LIFECYCLE-CHECKLIST
<td>Perf (latency/scale) is quantified and documented, with guarantees against regression.</td>
</tr>
<tr>
<td>Deprecation Policy</td>
<td>None</td>
<td>Support</td>
<td>None</td>
<td>Weak - 3 months</td>
<td>Firm - 1 year</td>
<td>No guarantees on backward compatibility. The feature may be dropped at any time without notice.</td>
<td>The overall feature will not be dropped, though details may change.</td>
<td>The feature will appear in released software for many subsequent versions.</td>
</tr>
<tr>
<td>Deprecation Policy</td>
<td>None, feature can be removed at any time</td>
<td>None, feature can be removed at any time</td>
<td>Weak, feature can be removed with 3 months of advanced notice</td>
<td>Strong, feature can be removed with 1 year of advanced notice, but there will usually be a supported upgrade path to a replacement feature</td>
</tr>
<tr>
<td>Versioning</td>
Expand Down
21 changes: 0 additions & 21 deletions OWNERS

This file was deleted.

2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -2,7 +2,7 @@

Welcome to the Istio community!

This is the starting point for becoming a contributor - improving code, improving docs, giving talks, etc.
This is the starting point for becoming a contributor - improving code, improving docs, giving talks, etc.

- [Introduction](#introduction)
- [Istio authors](#istio-authors)
Expand Down
12 changes: 6 additions & 6 deletions REVIEWING.md
Expand Up @@ -4,14 +4,14 @@ As a community we believe in the value of code reviews for all contributions.
Code reviews increase both the quality and readability of our code base, which
in turn produces high quality software.

This document provides guidelines for how the project's maintainers review
This document provides guidelines for how we review
issues and merge pull requests (PRs).

- [Pull requests welcome](#pull-requests-welcome)
- [Code reviewers](#code-reviewers)
- [Reviewing changes](#reviewing-changes)
- [Holds](#holds)
- [Project maintainers](#project-maintainers)
- [Approvers](#approvers)
- [Merging PRs](#merging-prs)

## Pull requests welcome
Expand Down Expand Up @@ -73,12 +73,12 @@ and offering an ETA measured in single-digit days at most. Any PR that has a
hold shall not be merged until the person who requested the hold acks the
review, withdraws their hold, or is overruled by a preponderance of maintainers.

## Project maintainers
## Approvers

Merging of PRs is done by the project maintainers.
Merging of PRs is done by [approvers](ROLES.md#approver) or by robots triggered by approvers.

Like many open source projects, becoming a maintainer is based on contributions
to the project. Please see our [community roles](https://github.com/istio/community/blob/master/ROLES.md)
Like many open source projects, becoming an approver is based on contributions
to the project. Please see our [community roles](ROLES.md)
document for information on how this is done.

## Merging PRs
Expand Down