- Issue created by @sunil_lnwebworks
- Status changed to Needs review
9 months ago 10:05am 14 March 2024 Hi
I created a readme template where author can easily update the requirements as per need, Please refer to the attached Patch File
- Status changed to Needs work
9 months ago 4:22pm 16 March 2024 - 🇵🇭Philippines clarkssquared
Hi
I applied the patch #3 and I noticed that the README.md content doesn't follow Drupal README.md template →
This is the README.md content that the patch created
# Username Module ## Introduction Brief introduction about the module and its purpose. ## Installation Instructions on how to install the module. Include any dependencies or prerequisites. ## Requirements List the required dependencies for the module. ## Contributing Provide guidelines for contributors. This may include how to report bugs, suggest enhancements, or submit pull requests. ## Usage Explain how to use the module. Provide examples or code snippets if applicable. ## Configuration Describe any configuration options or settings that users may need to adjust. ## License Specify the license under which the module is distributed. ## Acknowledgements Give credit to any individuals or organizations whose work has influenced or contributed to the module. ## Maintainers List the maintainers of the module.
- Status changed to Needs review
9 months ago 7:20am 18 March 2024 Hi @clarkssquared
I had updated the patch could you please review it.
- Status changed to Needs work
9 months ago 1:53pm 22 March 2024 - 🇵🇭Philippines clarkssquared
Hi
I reviewed the patch #6 and I confirmed that it applies successfully, however, I would recommend this.
in this section:
## Username ## Introduction Provides a variety of username modes for registration and login. For a full description of the module, visit the [project page](https://www.drupal.org/project/username).
You can do this instead:
## Username Username module provides a variety of username modes for registration and login. For a full description of the module, visit the [project page](https://www.drupal.org/project/username).
and if you do this, you can also remove the - Introduction from the ## Table of Contents sections.
the rest are good according to Drupal's template, kindly look at my suggestion and feedback
- 🇧🇹Bhutan dawadorjidd
I've successfully applied the readme.patch; however, during the application, there were some warnings regarding whitespace errors. I have enclosed a screenshot for your reference. Please take a look and do the needful.