zalando / zalando/zalando.github.io

Open source principles page

Open
#180 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

e: Misc
Dominant language
HTML
Stars
111
Forks
37
PR merge metrics
No merged PRs in 30d

Description

Get the principles page under Zalando ownership

The open source guild links to a principals page, which haven't been updated for ages:
https://zalando-open-source-principles.readthedocs.io/en/latest/

The source of this page is on a former employees github page:
https://github.com/elezar/open-source-principles

While the principals is fine on their own, the document should be updated to reflect where we are now and become part of the SSOT (single source of truth)

Tasks

These are the concrete tasks to complete before the issue is marked as done:

  • Figure out if we can take ownership of the readthedocs page
  • Review the content
  • Discuss the principals with the guild - do they still apply?
  • Figure out where this should be stored going forward
Expected delivery

What is the concrete outcome of this work: principals page on opensource.zalando or on the guild page - or the removal of the principals page - depending on discussions

Stakeholders

Who do we need to align with to make this happen? - add the deparment to get in touch with

  • OS Guild

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked Read the Docs principles page and its source repository at github.com/elezar/open-source-principles. Consult the OS Guild to determine whether the principles still apply, where the single source of truth should live, and whether Zalando can take ownership. Done means the agreed page is updated in its new location or the existing page is removed.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.