Formalize some feature guidelines #334
Merged
Conversation
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
KnVerey
requested review from
dturn,
kirs,
klautcomputing,
dalehamel and
stefanmb
kirs
approved these changes
Sep 19, 2018
|
|
||
| - This project's mission is to make it easy to ship changes to a Kubernetes namespace and understand the result. Features that introduce new classes of responsibility to the tool are not usually accepted. | ||
| - Deploys can be a very tempting place to cram features. Imagine a proposed feature actually fits better elsewhere—where might that be? (Examples: validator in CI, custom controller, initializer, pre-processing step in the CD pipeline, or even Kubernetes core) |
| - The basic ERB renderer included with the tool is intended as a convenience feature for a better out-of-the box experience. Providing complex rendering capabilities is out of scope of this project's mission, and enhancements in this area may be rejected. | ||
| - The deploy command does not officially support non-namespaced resource types. | ||
| - This project strives to be composable with other tools in the ecosystem, such as renderers and validators. The deploy command must work with any Kubernetes templates provided to it, no matter how they were generated. | ||
| - This project is open-source. Features tied to any specific organization (including Shopify) will be rejected. |
There was a problem hiding this comment.
Features tied to any specific organization (including Shopify) will be rejected.
While this is a good north start to have, we already do have some Shopify specific features, like ejson handling, Memcache and Redis resource types. What do we do about it? Do we want to mention that the rule only applies to new features?
There was a problem hiding this comment.
That's a good point, although ejson is also open-source so I think it's ok, and we're ripping out the proprietary CR code "Soon" (by reviving #188, more or less).
dturn
approved these changes
Sep 20, 2018
|
|
||
| - This project's mission is to make it easy to ship changes to a Kubernetes namespace and understand the result. Features that introduce new classes of responsibility to the tool are not usually accepted. | ||
| - Deploys can be a very tempting place to cram features. Imagine a proposed feature actually fits better elsewhere—where might that be? (Examples: validator in CI, custom controller, initializer, pre-processing step in the CD pipeline, or even Kubernetes core) |
There was a problem hiding this comment.
Imagine a proposed feature actually fits better elsewhere—where might that be? -> Does the proposed feature actually fits better elsewhere?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is something I've been meaning to propose for a while, both to help contributors and to sync up as maintainers.
cc @Shopify/cloudx