We could be using README.md instead of README.txt to make use of the nicer rendering via markdown.

Now that we've moved to GitLab, we should probably use Markdown instead of plain .txt files for our documentation.

CommentFileSizeAuthor
#2 3321795-2.patch1.05 KBpanwarjatin

Issue fork reassign_user_content-3321795

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

    panwarjatin created an issue. See original summary.

    panwarjatin’s picture

    panwarjatin commented
    Status: Active » Needs review
    StatusFileSize
    new 3321795-2.patch1.05 KB

    Changed README.txt to README.md please review it.

    Thank you.

    • berramou committed a24755d on 1.0.x 
      Issue #3321795 by panwarjatin: Replace README.txt with README.md
    ressa’s picture

    ressa
    he/him
    commented
    Status: Needs review » Needs work

    Thanks, please follow the pattern in the README.md template.

    • berramou committed b0bd7f1 on 1.0.x 
      Issue #3321795 by panwarjatin, berramou: Replace README.txt with README....
    berramou’s picture

    berramou commented
    Status: Needs work » Needs review
    Sonal Gyanani’s picture

    Sonal Gyanani commented

    Thanks, but there are still some issues in format of README.md file

    • Heading not All Uppercase should be capitalize
    • Use dashes (-) in place of asterisk for bulleted list
    • There are leading spaces
    • Links should have meaningful link text, for eg:-
      [Installing Drupal Modules](https://www.drupal.org/docs/extending-drupal/installing-drupal-modules).

    Please check format here Readme.md template

    Sonal Gyanani’s picture

    Sonal Gyanani commented
    Status: Needs review » Needs work
    ressa’s picture

    ressa
    he/him
    commented

    Thanks @Sonal Gyanani, awesome comments here and in other issues!

    I have confirmed your account. If you haven't already, you should be able to get Git access, perhaps you can enable it yourself? See Obtaining Git access.

    If you enable Git, you can create or add code or comments directly in issue forks (click "Create issue fork") for easier preview and commenting, so there are many benefits to this method.

    • berramou committed 8ab4457b on 1.0.x authored by panwarjatin 
      Issue #3321795 by panwarjatin, berramou: Replace README.txt with README....
    berramou’s picture

    berramou commented
    Status: Needs work » Needs review
    ressa’s picture

    ressa
    he/him
    commented

    @berramou: Shouldn't the Status be "Fixed", since you committed it to the module?

    berramou’s picture

    berramou commented

    Yes @ressa you are right, i just want to the others checks if there is no feedback after the fix.
    Thank you.

    berramou’s picture

    berramou commented
    Status: Needs review » Fixed
    ressa’s picture

    ressa
    he/him
    commented

    Thanks @berramou, happy new year!

    Perhaps @Sonal Gyanani can get credited for the very thorough review?

    berramou’s picture

    berramou commented
    berramou’s picture

    berramou commented
    Status: Fixed » Closed (fixed)