- Issue created by @Zaminmirza
- Assigned to mohd sahzad
- Issue was unassigned.
- Status changed to Needs review
10 months ago 1:09pm 24 January 2024 - Status changed to Needs work
3 months ago 2:12pm 31 July 2024 - 🇵🇭Philippines cleavinjosh
Hi @Mohd Sahzad,
I applied MR!1, it was applied smoothly and added the README.md file.
Just a few adjustments based on the README.md template → .
- After the project name, you can remove the "##Introduction" and just proceed with the purpose of the project since it is just after the project name.
- There should be 2 lines prior to #/## headings
- In the "##Recomended Modules", it should not be blank, either remove it or specify that the project do not have any requirements
Please feel free to correct my mistakes since I am still new to Drupal.
Thank you.
- 🇩🇪Germany jurgenhaas Gottmadingen
Please note: the readme file we possibly accept for this project will not have to follow that linked template. Instead, we will add a readme which can be used as the content of the main project page. It should describe the project and what value it provides to the user. Installation instructions, etc are misplaced in such files. Maybe many other modules do that, we don't.
Why? Because the readme is there to promote the project. It needs to help the user to decide whether they need that module or not. When it comes to download, installation and configuration, they will find that in the documentation. Or they don't even need that because the project browser will do all that for them.
So, the readme doesn't even need the module name as a title because they only ever get to read that file, when they are in the context of that module already. There, that title would only repeat what's available already, e.g. in project browser again.
Contributions to the readme file will only earn issue credits, if they work towards those objectives.
