Problem/Motivation

Convert README.txt to README.md

Steps to reproduce

Proposed resolution

Update readme to Markdown format.

Remaining tasks

User interface changes

API changes

Data model changes

CommentFileSizeAuthor
#12 README.md1.2 KBdineshreddymathuku
#4 3318676-4-after.png155.84 KBshyam_bhatt
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:

Comments

Bhanu951 created an issue. See original summary.

avpaderno’s picture

Status: Active » Needs review
shyam_bhatt’s picture

Status: Needs review » Reviewed & tested by the community
StatusFileSize
new155.84 KB

I have checked the "MR !1" file extension updated.

After
2022-11-03/3318676-4-after.png

avpaderno’s picture

Status: Reviewed & tested by the community » Needs work
-Features:
+## Features:

The colon after the header name is not necessary.

The copyright notice at the end of the file should probably be removed too. README files hosted on drupal.org don't generally show any copyright notice.

karanpagare made their first commit to this issue’s fork.

karanpagare’s picture

Status: Needs work » Needs review

Removed Colon and copyright in latest commit.

shyam_bhatt’s picture

Status: Needs review » Reviewed & tested by the community

The updated "README.md" looks fine to me.

andrew answer’s picture

1. Hi, is this a big problem? I created README.txt because this is the default format suggested by D.O. site when creating a new repository. See, for example, admin_toolbar, auto_login_url, field_group module and hundreds of others.

2. As for the copyright notice - you can see the Maintainers section with the authors in almost every module's README.txt . This is a common practice, and I follow this practice.

Please do not create solutions to these "overwhelming" problems.

avpaderno’s picture

@Andrew The list of maintainers isn't a copyright notice. In code licensed under GPLv2+, the copyright is probably hold also by all the users who contributed code with patches, not by a single user.

As for using a README.txt file instead of a README.md file, the Drupal coding standards says that every documentation file should have a .txt extension. The Markdown format that should be used is still discussed, and the Drupal coding standards don't describe which format should be used.
It's up to the maintainers, IMO, the decision of which format to use. It just happens that, now that Drupal.org uses Gitlab for its Git repositories, a README.md file is automatically rendered when users watch it on the repository.

dineshreddymathuku’s picture

Still need Some changes ill work on those

dineshreddymathuku’s picture

StatusFileSize
new1.2 KB

Please check once below Attachment
Thanks

andrew answer’s picture

Status: Reviewed & tested by the community » Fixed

Fixed in 1.0.5.

bhanu951’s picture

@Andrew Answer.

Can you let me know the reason why wasn't credits issued for any of the contributors or reviews for all the fixed issues?

I can understand not issuing credits for low quality contributions but here I can see quality contributions.

Incase if you are not aware on how to issue credits here is the documentation for it.

https://www.drupal.org/docs/develop/issues/issue-procedures-and-etiquett...

andrew answer’s picture

@Bhanu951,

I'm giving credits for the patching critical bugs, valuable new functionality, or significant documentation updates. You made almost nothing; the mass README renaming on D.O is a sort of "rating cheating", IMHO. This way the credits are devalued.

bhanu951’s picture

@Andrew I completely agree with you on this issue (I created this issue because I was working on other issues and observed this improvement), I am not referring to this issue alone I am referring to other four sibling issues created and merged. I think adding tests is a major contribution similarly other issue contributions are significant ones.

https://www.drupal.org/project/modules_info/issues/3318694

https://www.drupal.org/project/modules_info/issues/3318709

https://www.drupal.org/project/modules_info/issues/3318711

https://www.drupal.org/project/modules_info/issues/3318595

shyam_bhatt’s picture

@Andrew Agree with @Bhanu951
For the below issues, you should give credits to both the person. (Who give the patch and Who tested that patch)
https://www.drupal.org/project/modules_info/issues/3318709
https://www.drupal.org/project/modules_info/issues/3318711
https://www.drupal.org/project/modules_info/issues/3318595

andrew answer’s picture

@Bhanu951 @Shyam_Bhatt I wrote in every separate issue my opinion to every contribution. Hope this helps.
I think that crediting is a sort of "reward" for those who maintain the modules and not "a must" but "may" be gived to you and anyone who will post any comments, fixes and so on.

Status: Fixed » Closed (fixed)

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