Skip to content

Commit 0fa419e

Browse files
Merge pull request #45 from TallTed/patch-1
Fix typos, add dots, in CONTRIBUTING.md
2 parents f014e29 + e4fda03 commit 0fa419e

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -45,27 +45,27 @@ Software item must conform to the following format:
4545
```
4646

4747
In each case:
48-
- The link
49-
- Should be the name of the package or project
50-
- Should point to a specific module related to the category (e.g., in the 'SHACL Validators' section, link to `https://github.com/apache/jena/tree/main/jena-shacl`, not `https://github.com/apache/jena`)
48+
- The link:
49+
- Should be the name of the package or project.
50+
- Should point to a specific module related to the category (e.g., in the 'SHACL Validators' section, link to `https://github.com/apache/jena/tree/main/jena-shacl`, not `https://github.com/apache/jena`).
5151
- Activity info
52-
- Should consist of two badges
53-
- The latest known stable version badge (from any most common binary repository or GH Releases)
52+
- Should consist of two badges:
53+
- The latest known stable version badge (from any most common binary repository or GH Releases).
5454
- The recent repository activity badge (only one of these options):
55-
- "latest release date" (recommended) from any repository binary or GitHub Releases
56-
- if there is no published versions, then "last commit date"
57-
- Should not contain URL links
58-
- Use HTML `<img/>` badge format, not Markdown image, (e.g. use `<img alt="Latest Version" src="https://img.shields.io/crates/v/rudof-cli" align="top">` not `![Latest Version](https://img.shields.io/crates/v/rudof-cli.svg)`)
59-
- Use `<img align="top">` badge format for better inline alignment
60-
- Do not use any other badges (build status, dependencies, etc.)
61-
- Additional emoji can be used to mark commercial 💰 or abandoned ☠️ software
55+
- "latest release date" (recommended) from any repository binary or GitHub Releases.
56+
- if there is no published version, then "last commit date".
57+
- Should not contain URL links.
58+
- Use HTML `<img/>` badge format, not Markdown image (e.g., use `<img alt="Latest Version" src="https://img.shields.io/crates/v/rudof-cli" align="top">`, not `![Latest Version](https://img.shields.io/crates/v/rudof-cli.svg)`).
59+
- Use `<img align="top">` badge format for better inline alignment.
60+
- Do not use any other badges (build status, dependencies, etc.).
61+
- Additional emoji can be used to mark commercial 💰 or abandoned ☠️ software.
6262
- Descriptions
63-
- Should be clear, concise, and non-promotional
64-
- Should begin with a capital letter
65-
- May consist of several sentences
66-
- Should be separated from the activity info with spaces and a hyphen ` - `
67-
- Should contain license info and programming language at the end, formatted as ``` `text in code quotes` ```
68-
- Should follow the link on the same line and end with a punctuation mark. Remember to put a period `.` at the end of the project description
63+
- Should be clear, concise, and non-promotional.
64+
- Should begin with a capital letter.
65+
- May consist of several sentences.
66+
- Should be separated from the activity info a hyphen preceded and followed by spaces, ` - `.
67+
- Should contain license info and programming language at the end, formatted as ``` `text in code quotes` ```.
68+
- Should follow the link on the same line and end with a punctuation mark. Remember to put a period `.` at the end of the project description.
6969

7070
### Examples
7171

@@ -96,14 +96,14 @@ In general it is better to comply with linter's rules. But in some cases it is a
9696
- If you are adding reasonably the same URL link to several list's categories, you'll end up with duplication errors.
9797
- If you reasonably need more freedom in a description formatting, this will lead to formatting errors.
9898

99-
In this cases it is possible to enable/disable some linter's rules for the specific list item (lines) only with ```lint ignore``` (the recommended approach) or enable/disable it globally (not recommended) with ```lint disable``` and ```lint enable```.
99+
In this cases it is possible to enable and/or disable some linter rules for the specific list item (line) with ```lint ignore``` (the recommended approach) or enable and/or disable the rules globally (not recommended) with ```lint disable``` and/or ```lint enable```.
100100

101-
Just put the rule IDs after the "lint ignore" and separate it with a space from each other.
101+
Just put the rule IDs after `lint ignore` and separate them with spaces.
102102

103103
- double-link -- checks list item duplication
104104
- awesome-list-item -- checks list item formatting
105105

106-
Examples
106+
#### Examples
107107

108108
```
109109
<!--lint ignore double-link-->

0 commit comments

Comments
 (0)