Problem/Motivation

The current README.txt contains typos and some formatting issues.

Proposed resolution

This is a .txt file so brackets should be removed from links in the Introduction section.
Two lines prior to headings (except the first one).
Bullet lists should have hanging indents.
The link https://www.drupal.org/docs/8/extending-drupal-8/installing-drupal-8-mod... should be replaced with the permalink since node aliases change over time. Use this link: https://www.drupal.org/node/1897420.
line 7 and line 32: Using => Usage
In the requirements section provide a link the the Display Suite module
Spell out "ds" to "Display Suite" where appropriate
parametrs => parameters
viwe => view
Line 39: Module provide => Module provides
relation ship => relationship
apper = > appear
Line 55: Remove heading ##

Assigning to myself to begin work on the fixes

Issue fork friendship-3233376

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:

About issue forks

Comments

Stockfoot created an issue. See original summary.

Stockfoot opened merge request !2

Stockfoot closed merge request !2

Stockfoot opened merge request !3

stockfoot’s picture

stockfoot commented
Assigned: stockfoot » Unassigned
Status: Active » Needs review

I have made the required changes to the README.txt with the following Merge Request here - https://git.drupalcode.org/project/friendship/-/merge_requests/3.

I have unassigned myself and this is now ready for someone's review! Thanks!

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
Status: Needs review » Needs work

I am not sure how to leave a comment on the MR, so I'll just comment here:

I checked for grammar, spelling, correct links and formatting.

line 32 can go up on line 31
line 36 needs a hard break after “at”
line 56 needs a hard break after “relation”
line 57 needs a line break after “friendship”
Line 65 has a space at the end

Of course as hard breaks are added, the lines #'s will change.

Moving to needs work. Thanks for the updates!

stockfoot’s picture

stockfoot commented
Status: Needs work » Needs review

Made the recommended changes.
Ready for it to be reviewed and tested by the community

morganlyndel’s picture

morganlyndel commented
Assigned: Unassigned » morganlyndel

I'm assigning this to myself to review and test. Thanks!

morganlyndel’s picture

morganlyndel commented
Assigned: morganlyndel » Unassigned
Status: Needs review » Reviewed & tested by the community

I reviewed the merge request here: https://git.drupalcode.org/project/friendship/-/merge_requests/3/diffs

I did the following to review:
Check the diff to verify that the changes were appropriate.
Open the file in the integrated IDE and cross-referenced against the README standards documentation and an example README.

I didn't find anything that went against the guidelines.

Thanks!

vitaliyb98’s picture

vitaliyb98 commented
Status: Reviewed & tested by the community » Fixed

Merged, thank you all for your contribution!

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

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

Maintainers, credit people who helped resolve this issue.

Status: Fixed » Closed (fixed)

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