Design principles + README update#97
Merged
vito merged 12 commits intoconcourse:masterfrom Apr 7, 2021
Merged
Conversation
Signed-off-by: Alex Suraci <suraci.alex@gmail.com>
Signed-off-by: Alex Suraci <suraci.alex@gmail.com>
matthewpereira
requested changes
Mar 17, 2021
Signed-off-by: Alex Suraci <suraci.alex@gmail.com>
Signed-off-by: Alex Suraci <suraci.alex@gmail.com>
aoldershaw
approved these changes
Mar 22, 2021
matthewpereira
approved these changes
Mar 22, 2021
There was a problem hiding this comment.
@vito I added a pair of suggestions to make a few sentences a little clearer/easy to read, but they're optional/non-blocking. Otherwise LGTM! 
chenbh
reviewed
Mar 24, 2021
* eliminate as much passive voice as possible, clearly stating who is
responsible for each action instead
* clearer description of when an RFC may or may not be necessary
* document process for applying 'priority/{high,medium,low}' and 'help
wanted' labels
* document process for opening issue associated to merged RFC and
linking to it from the RFC
* integrate feedback collection into 'submitting an RFC' steps rather
than a separate section
* be a bit less demanding about commit style
* lots of wordsmithing for clarity and brevity
Signed-off-by: Alex Suraci <suraci.alex@gmail.com>
Signed-off-by: Alex Suraci <suraci.alex@gmail.com>
the 'reviewing an RFC' section will be linked to by the Concourse website, and is aimed at prospective RFC reviewers. this RFC assignment part is directed at RFC authors as part of explaining the process, so it should exist in the 'submitting an RFC' section instead. tweak wording and fix some typoes along the way. Signed-off-by: Alex Suraci <suraci.alex@gmail.com>
Signed-off-by: Alex Suraci <suraci.alex@gmail.com>
Member
Author
|
@concourse/core Think I'm finally done with the new README if y'all wanna give it a gander! |
Signed-off-by: Alex Suraci <suraci.alex@gmail.com>
Signed-off-by: Alex Suraci <suraci.alex@gmail.com>
chenbh
reviewed
Mar 29, 2021
Signed-off-by: Alex Suraci <suraci.alex@gmail.com> Co-authored-by: Daniel Chen <danielchen97dc@gmail.com>
clarafu
reviewed
Apr 1, 2021
Signed-off-by: Alex Suraci <suraci.alex@gmail.com>
Member
Author
|
Thanks for the feedback all! Went over it one more time and I think it's ready to merge; gonna hit the big green button now. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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 PR introduces a
DESIGN_PRINCIPLES.mddocument which codifies the set of principles underlying Concourse's feature design sensibilities. These principles have been referenced by the v10 blog post and many of my comments on GitHub so hopefully they don't feel too surprising.Along the way, this PR updates
README.mdto reference the design principles and the new process by which RFCs are placed directly on the Concourse website. (Which hasn't been shipped yet - I'll make this PR a non-draft once it's ready to be merged.)