docs(contributions): contribution process and criteria #526
Conversation
Inclusion of a contribution process and criteria within the community section of the site
robertjmccarthy
added
the
staging:request
docs/community/contribute.md
Outdated
| <!-- ## What happens next | ||
|
|
||
| ### Review and decision | ||
|
|
||
| The MOJ Design System Group will review your contribution and get back to you with a decision on whether your contribution will be accepted into the design system. | ||
|
|
||
| The Group may reach out to you to discuss your contribution before making a decision. | ||
|
|
||
| ### Developing your contribution | ||
|
|
||
| If your contribution is accepted, the Group will work with you to support the development of your contribution into a common style, component or pattern that other teams can reuse. | ||
|
|
||
| <article class="moj-ticket-panel" style="margin-top: 60px"> | ||
| <section class="moj-ticket-panel__content moj-ticket-panel__content--blue"> | ||
| <h3 class="govuk-heading-m govuk-!-margin-bottom-3">Useful links</h3> | ||
| <ul class="govuk-list"> | ||
| <li><a class="govuk-link" href="/community/criteria">Contribution criteria</a></li> | ||
| <li><a class="govuk-link" href="https://docs.google.com/spreadsheets/d/1TlF5XxAoE_SPB9JBg1IktY0W30d4kMElwSLGclzL0wQ/edit?usp=sharing">Contribution backlog</a></li> | ||
| <li><a class="govuk-link" href="https://forms.gle/Hp56F9mYxz8Mh4BZ8">Propose a contribution</a></li> | ||
| </ul> | ||
| </section> | ||
| </article> --> |
There was a problem hiding this comment.
Presumably this can be removed?
There was a problem hiding this comment.
Ah yes, good spot. It can be removed.
|
|
||
| ### Step 3: Propose your contribution | ||
|
|
||
| Propose a contribution using the [contribution form](https://forms.gle/Hp56F9mYxz8Mh4BZ8). When submitted, your contribution can be viewed on the [contribution backlog](https://docs.google.com/spreadsheets/d/1TlF5XxAoE_SPB9JBg1IktY0W30d4kMElwSLGclzL0wQ/edit?usp=sharing). |
There was a problem hiding this comment.
I think we should also highlight the ability to suggest a contribution over GitHub, since that's an easier way of sharing code changes for anyone who's already familiar with it.
There was a problem hiding this comment.
Agreed, as we want contributions to work for everyone so tooling needs to be right for different people.
But right now we need to balance this with handling contributions in an organised way that we can manage and review as a the MOJ Design System Group. Not suggesting this is perfect right now, but it's low barrier for people to contribute and easy for us to review contributions as a group.
There haven't been contributions for a while, and there could be a lot of contributions soon to come in. Having them coming in in different ways will mean we'll struggle to be organised at this very early stage.
Co-authored-by: Greg Tyler <[email protected]>
|
🎉 This PR is included in version 1.8.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Description of change
Inclusion of a contribution process and guidance on how to contribute into the MOJ Design System.