Problem/Motivation

README.md is now encouraged for Drupal projects.

Proposed resolution

Create one according to the README.md template containing information that follows the project page.

Remaining tasks

  1. Write a merge request - originally started by @fanton in #2 but rewritten by @mparker17 by #8
  2. Review and feedback - originally started by @mahima_mathur23 in #5 but the rewrite was skipped by @mparker17 by #8
  3. RTBC and feedback - skipped by @mparker17 by #8
  4. Commit - done by @mparker17 in #8
  5. Release

User interface changes

None.

API changes

None.

Data model changes

None.

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

fanton created an issue. See original summary.

fanton’s picture

Assigned: fanton » Unassigned
Status: Active » Needs review

Please review.

Sonal Gyanani made their first commit to this issue’s fork.

mahima_mathur23’s picture

Status: Needs review » Reviewed & tested by the community

Verified the MR. Moving to RTBC.

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

mparker17’s picture

Category: Task » Feature request
Issue tags: -

I've rebased the merge request onto the latest changes to 8.x-7.x.

  • mparker17 committed 1e3dabd7 on 8.x-7.x authored by fanton
    [#3331539] feat: Replace README.txt with README.md and update file...
mparker17’s picture

Component: Documentation » Code
Issue summary: View changes
Status: Reviewed & tested by the community » Fixed

I rewrote the file to follow what was in the 8.0.x branch and on the project page, because what was in the merge request from 2 years ago was a bit out-of-date.

I updated the issue summary to better record what happened for the release notes.

Now that this issue is closed, please review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, please credit people who helped resolve this issue.

Status: Fixed » Closed (fixed)

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