This pad contains the list which would eventully help me later to figure out what is left to be done in the context of migration of an actiivty that to ensure end-to-end migration of the Wikipages by WikiPort. All edits and suggestions are welcomed.
The list will also contain specific formats of pull requests and commit messges, other details which would be kept in mind for the people contributing to this project to ensure synchronization between contributors and make the task of reviewing easier.
Points to remember
- use migrate rather than migrated, to fit the imperative mood in the checklist,
- The name of the activity is redundant; whoever is reading the commit should already know which repository they are looking at.
- The link of the page migrated should be in the commit message; it will remain useful in future, because of the Internet - Archive or the Wiki history.
A worked out example using the checklist;
- start with a one line summary of the change; "Migrate documentation from Wiki",
- leave a blank line after the summary;
- explain the problem that is solved, unless the summary makes it obvious; "Documentation from http://wiki.sugarlabs.org/go/Activities/I_can_read was separate from the activity.",
- when the problem was introduced by a previous commit, mention the hash; not relevant,
- when the problem is in an issue or ticket, add "Fixes #1234"; "Part of a project to migrate activity documentation from Wiki.",
- avoid mentioning GitHub or other pull-requests, as these are not kept in git; not relevant,
- avoid mentioning any contest tasks or mentors; use pull-request comments instead; not relevant; and
- use imperative mood, like "add foo", or "port to bar"; use "Migrate" rather than "Migrated",
End Result:
Migrate documentation from Wiki
Documentation from http://wiki.sugarlabs.org/go/Activities/I_can_read was separate from the activity.
Part of a project to migrate activity documentation from Wiki. $PROJECT_URL
-
Summary of what it does Example: This PR migrates wiki-pages of I-can-read Activity from https://wiki.sugarlabs.org/go/Activities/I_can_read[1]
-
A brief description of the changes and commits made
-
In reference to which project, category, ticket number, issue number Example : In reference to - Project on Migration of wiki Activity pages to git [WikiPort]
-
Status of the pull request (Ready to be merged or not)
This PR migrates wiki-pages of I-can-read Activity from https://wiki.sugarlabs.org/go/Activities/LetterMatch [1]
Description
- The PR migrates all documentation from lettermatch activity (including images) from the wiki-page [1] to GitHub flavored Markdown in the repository using a script with minimum interventions from the user.
- Fixed some grammatical errors.
- Fixed section "Where to report problems?"
In reference to - Project on Migration of wiki Activity pages to git [WikiPort]
To-do
- When PR is merged; Delete [1] and all images associated with it. [Using MediaWiki API]
Status - Complete
Some more points to remember (Thanks @Pro-Panda)
- Migrate the documentation from wiki to GitHub and submit a PR for the same
- If there are any links which will get broken afterwards (probably links to other activities documentation), mark that PR as [In progress]
- Migrate the pages in these links
- Update the In progress PR and change its status from In-Progress to complete
Other Details
- Images and other media fetched from activity pages to be stored in a new folder without disturbing the previous structure. Name this folder as "docs"