Skip to content

Docs: Improve Contributors Guide Structure #12916

@mkaz

Description

@mkaz

The Contributors Guide in the Handbook could be organized a bit better, there are also two sources of contributors information which are loosely cross-linked. The following outline was proposed in: #10911

  1. Contributor Handbook
    1. Introduction
    2. Philosophy
    3. Design
      1. Design Resources
      2. Link to HIG
    4. Develop
      1. Coding guidelines
      2. Testing
      3. Release Process
      4. Deprecations
      5. Links to components/package references
    5. General
      1. History
      2. Glossary
      3. FAQs
      4. Repository management guidelines

This ticket is to confirm that is the outline we still want, secondly how to incorporate the information from CONTRIBUTING.md. I'm not sure how much of CONTRIBUTING.md should be maintained there vs. moving it to within the handbook, open to suggestions.

Current Contributors Guide: https://wordpress.org/gutenberg/handbook/contributors/

Current CONTRIBUTING.md: https://github.com/WordPress/gutenberg/blob/master/CONTRIBUTING.md

Metadata

Metadata

Assignees

Type

No type
No fields configured for issues without a type.

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions