moodle / moodle/devdocs

[docs] Migrate Commit_cheat_sheet to general/development/abc/commit-comments.md and other places

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

Nobody has claimed this yet.

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

Description

The URL of the page on https://docs.moodle.org/dev/

https://docs.moodle.org/dev/Commit_cheat_sheet

Is this documentation specific to a Moodle version?

No

What location would you suggest in the new docs?

general/development/abc/commit-comments.md

Note, work started at https://github.com/timhunt/devdocs/commit/commits, but needs a bit of refactoring before I am ready to open a pull request.

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 with the existing Commit_cheat_sheet page and the proposed destination general/development/abc/commit-comments.md. Review the work already started in timhunt/devdocs at the commits page, refactor it as needed, and confirm the content has been migrated to the new location and other required places before opening a pull request.

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
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.