Problem/Motivation

The README.txt can be converted to a Readme.md file so we have a better integration with GitLab.

Steps to reproduce

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

Issue fork piwik_pro-3482195

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

timohuisman created an issue. See original summary.

timohuisman opened merge request !6

timohuisman changed the visibility of the branch 3482195-readme-md to hidden.

timohuisman’s picture

timohuisman
Primary language Dutch
Location Leiden, Netherlands
commented
Status: Active » Needs review

Followed the best-practices listed on https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or.... Chose to place the introduction above the table of content because it felt more logical in that order. The listed examples are not consistent where the introduction should be.

heikkiy’s picture

heikkiy commented

Added some improvement ideas to the MR. I think it could include additional information and get ideas for example from https://git.drupalcode.org/project/search_api_solr/-/blob/4.x/README.md and https://git.drupalcode.org/project/metatag/-/blob/8.x-1.x/README.md?ref_....

But these are out of scope for this issue and we can create a new issue for improving the project readme.

heikkiy’s picture

heikkiy commented
Status: Needs review » Reviewed & tested by the community

This change looks good to me now looking at https://git.drupalcode.org/issue/piwik_pro-3482195/-/blob/3482195-replac....

  • heikkiy committed 2147f6ad on 1.1.x authored by timohuisman 
    Issue #3482195 by timohuisman, heikkiy: Replace README.txt to Readme.md...
heikkiy’s picture

heikkiy commented
Status: Reviewed & tested by the community » Fixed

Merged.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.