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

Add details of review process to Contributor Handbook #273

Merged
merged 13 commits into from
Jan 24, 2022

Conversation

spier
Copy link
Member

@spier spier commented Jan 10, 2021

We have used the new maturity levels for the patterns for over a year now.
I figured we could aggregate our working knowledge in the Contributor Handbook, to make it easier for new contributors to understand what we are after when using the different maturity levels.

This PR also starts to implement #170 and #171.

Changes made:

  • Adds information about automatic checks
  • Describe some unspoken review expectations
  • Adds where the output artifacts in each level are published
  • Document where to keep assets (images etc) that are used in patterns.
    • Most are kept in /assets, while the 3 project-setup patterns keep the assets in their own sub-folders
  • (basic) first Style Guide and Glossary

…ons. Also adds where the output artifacts in each level are kept.
@spier
Copy link
Member Author

spier commented Jan 10, 2021

@maxcapraro as you wrote the first version of the Contributor Handbook, can you help us understand the intended semantic difference between the Validation requirements and Content requirements?

Understanding this better will help to make better decisions about which info to put where.

@lenucksi lenucksi added the ⚙️ Type - Meta Improving how we collaborate in this repo is the main focus of this issue / PR label Jan 10, 2021
@spier spier marked this pull request as ready for review February 14, 2021 10:32
@spier
Copy link
Member Author

spier commented Feb 14, 2021

@tapjdey @WillemJiang as you have made your first contributes to our Patterns recently, it would be great to get your feedback here.

This PR tries to explain better how we go about reviewing patterns.

You can focus your feedback on levels 1 and 2, as we don't have level 3 patterns yet.

If you have any further thoughts about this, let us know. And thanks for you help!

@spier spier changed the title Add working knowledge about the review process to the Contributor Handbook Add details of review process to Contributor Handbook Jan 22, 2022
@spier
Copy link
Member Author

spier commented Jan 22, 2022

@robtuley as you recently worked on a pattern, I was wondering if you could review if this PR here is a helpful improvement for the documentation in our Contributor Handbook?

Copy link
Collaborator

@robtuley robtuley left a comment

Choose a reason for hiding this comment

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

This looks like a helpful update to me as a recent contributor.

@spier spier merged commit 1ad084a into main Jan 24, 2022
@spier spier deleted the improve-contributor-handbook branch January 24, 2022 07:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
⚙️ Type - Meta Improving how we collaborate in this repo is the main focus of this issue / PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants