Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
77 lines (54 loc) · 3.21 KB

CONTRIBUTING.md

File metadata and controls

77 lines (54 loc) · 3.21 KB
Raw

Contributing to WordPress Credits Documentation

Thank you for your interest in improving the documentation for WordPress Credits—an official initiative by the WordPress Foundation that connects academic institutions with the global WordPress open source community.

This repository (WPCredits) is used to coordinate, draft, and maintain public documentation related to the WordPress Credits program, including:

  • Handbook content
  • Onboarding guides
  • Contribution templates
  • Program policies
  • Sponsor and institutional partnership guidelines

All contributions help make the program more transparent, accessible, and sustainable.

What This Repository Is For

This repo does not track individual student or mentor activity.
Instead, it hosts public-facing documentation that supports the program’s operations, outreach, and scalability.

If you’re looking to:

  • Submit student reports → contact your mentor or university coordinator
  • Apply as a mentor → visit wordpress.org/education/credits
  • Report bugs in WordPress software

…then this is not the right place. But if you want to improve WP Credits documentation, you’re very welcome!

How to Contribute

1. Review Existing Content

Before contributing:

2. Open an Issue First (Recommended)

For substantial changes (new sections, structural updates, policy clarifications), open an issue to propose your idea and get feedback from maintainers.

3. Submit a Pull Request

We welcome PRs for:

  • Fixing typos, broken links, or formatting issues
  • Improving clarity or tone in existing docs
  • Adding new documentation (e.g., templates, FAQs, partnership guidelines)
  • Translating content (coordinate via issue first)

Best practices:

  • Fork the repo
  • Create a descriptive branch (e.g., fix/typo-handbook-intro or feat/sponsor-guidelines)
  • Write clear commit messages
  • Reference any related issue (e.g., Closes #12)

4. Follow the Style Guide

  • Use clear, inclusive, and professional language
  • Write in English (translations are managed separately)
  • Prefer active voice: “The program supports…” vs “It is supported by…”
  • Keep paragraphs short and scannable

Code of Conduct

All contributors must adhere to the WordPress Community Code of Conduct.
We are committed to fostering a respectful, collaborative, and inclusive environment.

Questions or Unsure?

Thank you for helping document and sustain one of WordPress’s most promising educational initiatives.
Your contribution ensures that institutions, sponsors, and future contributors can understand, join, and grow with WordPress Credits.