Add README with relevant details and instructions on installing with composer. Also mirror the content on the project page.

CommentFileSizeAuthor
#10 3077595-10.patch1.32 KBdeepak goyal
#7 3077595-7.patch1.38 KBWebbeh
#6 README.txt1.2 KBdeepak goyal
#2 README.txt1.11 KBbinnythomas

Comments

hussainweb created an issue. See original summary.

binnythomas’s picture

binnythomas commented
StatusFileSize
new README.txt1.11 KB

I have added a customized Readme file for this project based on the README template file @ https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...

binnythomas’s picture

binnythomas commented
binnythomas’s picture

binnythomas commented
Status: Active » Needs review
hussainweb’s picture

hussainweb
Primary language English
commented
Status: Needs review » Needs work

@binnythomas, thanks for this. It would be better if this were a patch but this is also fine.

More particularly, can you update the documentation to indicate this module must be installed via composer. It doesn't work otherwise.

deepak goyal’s picture

deepak goyal commented
Status: Needs work » Needs review
StatusFileSize
new README.txt1.2 KB

Updated file please review.

Webbeh’s picture

Webbeh
he/him/his
Location Georgia, USA
commented
StatusFileSize
new 3077595-7.patch1.38 KB

Re-rolled #6 into a patch.

Also hard-wrapped introduction at 80 characters, and rewrote CONFIGURATION to better encompass the expected new functionality upon enabling.

hussainweb’s picture

hussainweb
Primary language English
commented
Status: Needs review » Needs work

Thanks for all the work. Some more comments.

  1. +++ b/README.txt
@@ -0,0 +1,54 @@
+  $ composer require 'drupal/do_username:1.x-dev'

    This can be skipped as it is covered in the INSTALLATION section. 

  2. +++ b/README.txt
@@ -0,0 +1,54 @@
+   $ composer require 'drupal/do_username:1.x-dev'
+   https://www.drupal.org/docs/develop/using-composer/using-composer-to-install-drupal-and-manage-dependencies

    I'd prefer using `^1.0` here, even though there is no stable release right now. 

  3. +++ b/README.txt
@@ -0,0 +1,54 @@
+No configuration is needed. When enabled, a new field type is available to add
+to entities - a 'Drupal.org username'.

    This could be misleading. When enabled, apart from the field type, a field is added to user entities. The field still needs to be enabled on form display and entity display, if required. The field may be added/removed from other entities as required as well.

deepak goyal’s picture

deepak goyal commented
Assigned: Unassigned » deepak goyal
deepak goyal’s picture

deepak goyal commented
Status: Needs work » Needs review
StatusFileSize
new 3077595-10.patch1.32 KB

Hi @hussainweb I have updated the patch please review.

Webbeh’s picture

Webbeh
he/him/his
Location Georgia, USA
commented
Assigned: deepak goyal » Unassigned

  • hussainweb committed b267c95 on 8.x-1.x 
    Issue #3077595 by Deepak Goyal, Webbeh, binnythomas, hussainweb: Add...
hussainweb’s picture

hussainweb
Primary language English
commented
Status: Needs review » Fixed

Thanks! I made a slight tweak and committed the patch.

Status: Fixed » Closed (fixed)

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