moodle / moodle/devdocs

[docs] Create documentation for Contributing to docs

Open
#45 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement help wanted
Dominant language
TypeScript
Stars
74
Forks
652
Avg merge
2d 50m
Merged PRs (30d)
12

Description

What is the Moodle feature that needs documenting?

We need to write:

  • CONTRIBUTING.md
  • Something in the actual docs, maybe under Community
Is this documentation specific to a Moodle version?

No

Are you able to provide a patch for this?

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the repository's existing documentation structure and the requested CONtributing.md path. Identify where Community documentation belongs and compare nearby contribution guidance. Done means adding contribution instructions for documentation work in CONtributing.md and an appropriate page under Community, with both locations linked or discoverable.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.