- Merge request !1Issue #3333681: Update README.md file according to README.md template โ (Open) created by shubham rathore
- ๐ฎ๐ณIndia Nupur Badola
Installation section is given in Table of contents and also it is a required (mandatory) section as per readme.md file template. However it is missing from the readme.md file.
- Status changed to Needs work
over 1 year ago 9:58am 12 September 2023 - ๐ฎ๐ณIndia Anjali Mehta
Anjali Mehta โ made their first commit to this issueโs fork.
- Status changed to Needs review
over 1 year ago 4:36am 13 September 2023 - Status changed to RTBC
over 1 year ago 12:32pm 13 September 2023 - ๐ฎ๐ณIndia Nupur Badola
Reviewed MR!1, the patch is updated as per the readme.md file template. Hence marking it to RTBC.
- Status changed to Needs work
over 1 year ago 4:27pm 21 September 2023 - First commit to issue fork.
- Status changed to Needs review
about 1 year ago 4:17pm 27 September 2023 - ๐ฎ๐ณIndia sakthi_dev
Rebased with 1.0.x latest commits. Please review. If needs changes please update.
- Status changed to Needs work
about 1 year ago 7:45am 21 December 2023 - ๐ฎ๐ณIndia Nupur Badola
Reviewed MR!1, the patch is not cleanly applied.
file does not follow the readme.md template format:- ads via Carbon Get 10 Free Images From Adobe Stock. Start Now. ADS VIA CARBON Advertising sustains the DA. Ads are hidden for members. Join today On this page README format README sections Project name and introduction Table of contents (TOC) Requirements Recommended modules Installation Configuration Troubleshooting & FAQ Maintainers Changes from README.txt Advanced help module Sample README Documenting your project Help text standards Module documentation guidelines Project page template README Template Working with Drupal's Help system Using simplytest.me as a project demo Help Topic Standards README.md template Primary tabsToggle Edit Discuss View history Last updated on 30 November 2023 The Drupal community recommends using the Markdown format to create a README.md file. For a quick introduction to Markdown, see Markdown Guide's Basic Syntax or GitLab Flavored Markdown (GLFM) for a more comprehensive run-down. README documentation can include more Markdown-features than those used in the example snippets in this template. For instance, Markdown let you create hyperlinks that can be clicked when the README.md is rendered in GitLab or by a compatible program (e.g. Advanced Help). You can generate a boilerplate README.md with the following command: drush generate readme. The generated text does not follow these guidelines exactly, but may serve as a good starting point. README format Drupal recommends the following README formatting: Headings capitalized with an initial capital, following standard English sentence rules Headings prefixed with #/##/### to indicate level of heading (h1/h2/h3) followed by a blank line Project name is the first line of the document, and only level one heading (#) Two lines prior to ##/### headings No leading or trailing spaces Bulleted lists denoted by dashes (-) Ordered lists use "1", for easier updates and to avoid errors (see Configuration) Nested lists indented with 4 spaces Links should have a meaningful link text, for example: [Drupal](https://www.drupal.org/) (i.e. not just the URL) Text manually word-wrapped within around 80 cols README sections Drupal recommends the following README sections: Project name and introduction (required) Table of contents (optional) Requirements (required) Recommended modules (optional) Installation (required, unless a separate INSTALL.md is provided) Configuration (required) Troubleshooting & FAQ (optional) Maintainers (optional)
- Status changed to Needs review
about 1 year ago 11:07am 21 December 2023 - Status changed to RTBC
about 1 year ago 3:43am 22 December 2023 - ๐ต๐ญPhilippines kenyoOwen
Hi Anjali Mehta
I reviewed your changes and applied a patch and it applied successfully on my end. And I reviewed your changes and it resolved the feedback of comment #12 and it follows the README.md template. โ
Thank you