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

Adding a design proposal template and README. #1838

Merged
merged 10 commits into from
Apr 1, 2019
4 changes: 2 additions & 2 deletions docs/design_proposals/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ For any new feature, config or big changes, please add a design proposal documen
as described in [Design Proposal Template](./design-proposal-template.md).

Once you create a PR with the proposal, someone from the core team will be
assigned as a design sheppard. The role of the design sheppard will be to make
assigned as a design shepherd. The role of the design shepherd will be to make
sure,

1. The feature/change is within Skaffold Philosophy and not a one off
Expand All @@ -22,6 +22,6 @@ sure,
3. When changing any existing feature, the implementation plan adheres to
[skaffold deprecation policy](./../../deprecation-policy.md)

Once the proposals in a reasonale shape, we can discuss it in Skaffold bi-weekly
Once the proposal is in a reasonale shape, we can discuss it in Skaffold bi-weekly
meeting to address any open concerns, and reach to a decision i.e. accept or
punt.
21 changes: 11 additions & 10 deletions docs/design_proposals/design-proposal-template.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# Title

* Author(s): \<your name\>
* Design Shepherd: As mentioned in the document here.
* Design Shepherd: \<skaffold-core-team-member\>

If you are already working with someone mention their name.
If not, please leave this empty, it will be assigned to a core team member.
* Date: \<date\>
* Status: [Draft/Reviewed/Complete]

## Background

Expand All @@ -13,7 +17,8 @@ Please provide an rationale covering following points:

1. Why is this required?
2. If its re-design, What are cons with current implementation?
3. Are there any another work-around and if yes, why not keep using it.
3. Is there any another work-around and if yes, why not keep using it.
4. Mention related issues, if there are any.****

Here is an example snippet for a new feature:

Expand Down Expand Up @@ -43,8 +48,10 @@ Please describe your solution. Please list any:

For a new config change, please mention:

* If its a backward compatible config change
* If its a backward compatible config change, is there a migration path?
* If its a backward compatible config change ?
* If the answer to above question is yes, what would be the deprecation policy?
See [deprecation-policy](./../../deprecation-policy.md#how-do-we-deprecate-things)
requirements.

### Open Issues/Question

Expand All @@ -68,15 +75,9 @@ ___
2. Add inference logic for docker and examples.
3. Support both `infer` and user defined map with precedence rules implemented.
4. Finally, support builder plugins to add sync patterns.
___

For re-factor proposal identify smaller changes like:
___

1. Add new package skeleton. and any new objects with no functionality.
2. Move code from old place to newly added objects.

___

## Integration test plan

Expand Down