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

Incubation docs #1

Merged
merged 1 commit into from
Jun 11, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions _docs/releasing/incubation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
title: Incubation to Graduation
author: OST
date: 2018-06-07
banner:
image: coding.jpg
category: Releasing
---

#### This section describes all the minimum requirements that all new projects must meet before they will be fully accepted into the main Zalando Github organisation.

### Summary

- Quality indicators for incubator projects
- Review of activity
- Review assessment
- Graduation

---

### Quality indicators for incubator projects

Before your start thinking about graduation, you need to make sure you are ready and meet the following requirements.

- Have a clear vision and a long term plan for your project
- Commit to be part of the Zalando Github organisation
- Project is used and benefits to Zalando
- Have multiple maintainers from diverse background and URM (under represented minority)
- Project is compliant and has all the necessary documentation

All these acts have an influence on your project getting graduated.

### Review of activity

Each project in the incubator shall undergo a regular review of progress by the Review Group. Such reviews shall occur at least quarterly. The Review Group may choose to review individual projects with greater frequency. At least one week prior to each review, the Mentor must produce a report for the Review Group detailing overall progress with a focus on the preceding review period.

The Review Group will be interested in the following points for the status check. The project -

- Has regular activity
- Seeks and responds to feedback and suggestions
- Accepts contributions
- Responds to Issues, Pull Requests etc.

### Review assessment

After each review, the Review Group shall produce an assessment of the project. The assessment shall contain one of three recommendations:

- that the project be Terminated;
- that the project continues in Incubation;
- that the project be Graduated from Incubation.

### Graduation

Graduation is the process where your project gets accepted into the main Zalando Github organisation. This is a democratic process, in the end, it comes down to a Vote. The road to graduation is fairly simple but does take time and effort.

Prior to graduation, a project must meet the following requirements / quality indicators:

- High activity: The project is highly visible and has good statistics - stars, forks etc., actively used, has regular releases or is well maintained.
Copy link
Owner

Choose a reason for hiding this comment

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

I think we should remove the claus on "good statistics", simply state that high activity is well maintained and have regular releases


- Community driven: The project works to attract external contributors, builds a diverse community and is a source to get new hires for Zalando.

- Promotion: The project has a website, social media channels.

- Never leaves the org
Copy link
Owner

Choose a reason for hiding this comment

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

Clearify that zalando and projects must be aware that a graduated project never leaves the org, so there is a responsibility to maintain it long term

7 changes: 3 additions & 4 deletions _docs/releasing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,9 @@ Use [new-project](https://github.com/perploug/new-project)(TODO: move to zalando
Besides the rules of play, there is also a set of best practices which we highly recommend you implement.

1. Have a code of conduct and enforce it to create a safe environment for collaboration
2. Have a clear vision and scope of your project
3. Set clear expectations for responses - let users know if your time is limited
4. Ask for help and be open to what kind of contributions would help your project
5. Be mindful of your documentation
2. Set clear expectations for responses - let users know if your time is limited
Copy link
Owner

Choose a reason for hiding this comment

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

Don't think this clause should be removed - it might not be a requirement for incubation - but it is a best practices and a project should think of this as early as possible

3. Ask for help and be open to what kind of contributions would help your project
4. Be mindful of your documentation

[opensource.guide](https://opensource.guide/building-community/) has plenty more resources and recommendations for maintainers.

Expand Down