Propose the creation of best practices and guidelines #150
Conversation
Signed-off-by: Sambhav Kothari <[email protected]>
Signed-off-by: Sambhav Kothari <[email protected]>
Signed-off-by: Sambhav Kothari <[email protected]>
sambhav
changed the title
sambhav
changed the title
There was a problem hiding this comment.
In general, I think this impetus is great. We had discussed having FAQs in the docs for various tools, and I think this can fit in that same general category of non-intuitive information we want to make sure is understood and can be found. Definitely a fan of this!
|
|
||
| ## Extend the spec | ||
|
|
||
| Have an extension to the spec that contains a list of `SHOULD`s and `MAY`s that capture the guidelines. This may however confuse users and may tie up something like the `spec` which is not geared towards end-users to `guidelines` which are supposed to be. |
There was a problem hiding this comment.
Definitely against this idea - the spec is hard enough to read without asking people to read it even more for best practices, which should by their nature be easy to understand.
| - The exact set of guidelines that should be in the first cut of the repository | ||
| - Topics and details to cover |
There was a problem hiding this comment.
I wonder if creating a discussion would be a good way of seeding the initial set of guidelines.
|
FCP based on majority sub-team binding votes. To be merged 4/20. CC: @buildpacks/core-team |
There was a problem hiding this comment.
I love this idea and I think @jromero's suggestion to start a discussion is a great way to move this forward.
jromero
added
the
scope/team
[#150] Signed-off-by: Joe Kutner <[email protected]>
Signed-off-by: Sambhav Kothari [email protected]
Readable
@buildpacks/learning-maintainers @buildpacks/learning-contributors - please feel free to collaborate on the RFC and edit it :)