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

Add a contributor checklist for godot-doc contributions #9193

Open
12 tasks
StripedMonkey opened this issue Apr 7, 2024 · 0 comments · May be fixed by #10170
Open
12 tasks

Add a contributor checklist for godot-doc contributions #9193

StripedMonkey opened this issue Apr 7, 2024 · 0 comments · May be fixed by #10170
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 enhancement

Comments

@StripedMonkey
Copy link

I have been off and on working towards some documentation for the manual's "asset pipeline" section, and I have felt that the contribution resources for documentation specifically are rather confusing and scattered. Part of what I think would help significantly with my (and perhaps others) confidence when trying to make contributions is a checklist for what I need to do before making a contribution.

The idea here isn't to replace the existing documentation on contributions, but to make it easier for everyone to validate their own work before submitting for review. Some things are hard or outright missing from the docs, and I believe a checklist can help with exposing areas that need work, or at least making them more accessible to new contributors.

Below is a brief (incomplete) example of the kinds of things I'm hoping to see in such a checklist. Ideally these should be elaborated elsewhere in the docs, but it provides a summary instead of requiring a thorough reading of the entire documentation beforehand. Certain things here are additions I know are not mentioned in the docs, but have come up in conversation in the Godot Docs #documentation chat (redirects and hard line wrapping).


General content checks

  • The Writing and Content Guidelines have been read and understood
    • No unnecessary adjectives
    • No use of banned words
    • Only use explicit references
  • When renaming pages, ensure that the old pages have a corresponding redirect in _tools/redirects/redirects.csv to the new page.
  • Ensure consistent use of common vocabulary for interface locations, tools, etc.
  • Content is hard-wrapped in source to between 80 and 100 characters

Image checks

  • Images should be constrained to at most 1080p

Renames and reorganization

  • Any document pages which have been moved or renamed need have redirects.csv updated accordingly.

Code sample checks

  • no foo/bar/baz names over real-world names
  • prefer dynamic typing over static typing
  • use explicit return types and arguments
@tetrapod00 tetrapod00 linked a pull request Oct 30, 2024 that will close this issue
@tetrapod00 tetrapod00 added 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 enhancement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants