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

[Draft] Add docs contribution checklist page #10170

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

tetrapod00
Copy link
Contributor

@tetrapod00 tetrapod00 commented Oct 30, 2024

Resolves #9193.

This PR adds a new page to the Writing documentation section. It is a list of all of the content, style, and formatting guidelines that manual contributions are expected to follow. Each entry in the page concisely summarizes the guideline, then links to the section of docs that describes the guideline in full.

It is intended to be used:

  • By contributors to check their own work, in order to (hopefully) reduce the work needed during reviews.
  • By reviewers to see a summary of guidelines while reviewing. The links should make it easier to cite guidelines and link to rules when reviewing.

#10169 needs to be merged first, since this references some guidelines in that PR.

@tetrapod00 tetrapod00 added discussion content:new page Issues and PRs related to creation of new documentation pages for new or undocumented features area:contributing Issues and PRs related to the Contributing/Development section of the documentation labels Nov 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:contributing Issues and PRs related to the Contributing/Development section of the documentation content:new page Issues and PRs related to creation of new documentation pages for new or undocumented features discussion
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a contributor checklist for godot-doc contributions
1 participant