Page MenuHomePhabricator

Consolidate various in-repo docs about getting started into a single standard for all repos
Open, Needs TriagePublic

Description

Current we have a mixture of places in different repos where the basic facts of reality are stated to various extents:

  1. This repo is maintained by and for the Wikimedia community at large.
  2. This repo is governed by the Code of Conduct for Technical spaces.
  3. This repo is governed by the Wikimedia Universal Code of Conduct.
  4. You can get started by looking at the Wikimedia Developer Portal

Some, none, or all of this is stated in-repo in various files, including:

  • README
  • README.md
  • CODE_OF_CONDUCT
  • CODE_OF_CONDUCT.md
  • CODE_OF_CONDUCT.rst(!)
  • CONTRIBUTING
  • CONTRIBUTING.md

… and is often outdated. Following on from the mostly-complete T165540, perhaps it's time to refresh the wording, make it more general than just the CoC, and check that we're also doing this e.g. on GitHub- and Wikimedia GitLab-hosted repos?

Event Timeline

@Jdforrester-WMF: Hi, as Developer-Advocacy was tagged in this task, could you elaborate on this task's relation to that team? Thanks!

@Jdforrester-WMF: Hi, as Developer-Advocacy was tagged in this task, could you elaborate on this task's relation to that team? Thanks!

Yes, I wanted you lot to be aware and potentially object/highlight work already in motion, as this is a key area of your work, especially around welcoming new contributors to technical projects, and I don't want to tread on any toes! Happy to proceed without if everyone is content (though I wasn't thinking of picking this up any time soon, this was just an aide-mémoire when the concept came up in a meeting yesterday.

I personally support the idea of single-sourcing and updating this type of content as much as possible, but do we (does anyone) have a clear sense of which repos share the same "reality" when it comes to these types of docs? Is "GitHub- and Wikimedia GitLab-hosted repos" a concrete group of repos that we can confidently say share the same code of conduct, contributing guidelines, and entry-points for beginners? Or would this task involve identifying which repos could actually use a single-sourced set of core docs? I feel uncertain if a "create the content and they will come" approach would be effective in this ecosystem, but am open to ideas :-)