Skip to content

Commit 855cdc7

Browse files
Merge branch 'main' into shexer
2 parents d8a2f27 + a9943f4 commit 855cdc7

File tree

2 files changed

+87
-45
lines changed

2 files changed

+87
-45
lines changed

CONTRIBUTING.md

Lines changed: 42 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -45,23 +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)
54-
- The recent repository activity badge
55-
- Use `<img align="top">` badge format for better inline alignment
56-
- Do not use any other badges (build status, dependencies, etc.)
57-
- Additional emoji can be used to mark commercial 💰 or abandoned ☠️ software
52+
- Should consist of two badges:
53+
- The latest known stable version badge (from any most common binary repository or GH Releases).
54+
- 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 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.
5862
- Descriptions
59-
- Should be clear, concise, and non-promotional
60-
- Should begin with a capital letter
61-
- May consist of several sentences
62-
- Should be separated from the activity info with spaces and a hyphen ` - `
63-
- Should contain license info and programming language at the end, formatted as ``` `text in code quotes` ```
64-
- 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.
6569

6670
### Examples
6771

@@ -84,6 +88,29 @@ With a description:
8488
- [Apache Jena SHACL](https://github.com/apache/jena/tree/main/jena-shacl) <img alt="Maven Central Version" src="https://img.shields.io/maven-central/v/org.apache.jena/jena-shacl" align="top"> <img alt="Maven Central Last Update" src="https://img.shields.io/maven-central/last-update/org.apache.jena/jena-shacl" align="top"> - Supports SHACL Core, SHACL-SPARQL; [docs](https://jena.apache.org/documentation/shacl/index.html); `Apache-2.0` license; `Java`.
8589
```
8690

91+
### Ignoring some linter's errors
92+
93+
Our list [awesome lint](https://github.com/sindresorhus/awesome-lint)
94+
95+
In general it is better to comply with linter's rules. But in some cases it is acceptable to bypass it:
96+
- If you are adding reasonably the same URL link to several list's categories, you'll end up with duplication errors.
97+
- If you reasonably need more freedom in a description formatting, this will lead to formatting errors.
98+
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```.
100+
101+
Just put the rule IDs after `lint ignore` and separate them with spaces.
102+
103+
- double-link -- checks list item duplication
104+
- awesome-list-item -- checks list item formatting
105+
106+
#### Examples
107+
108+
```
109+
<!--lint ignore double-link-->
110+
<!--lint ignore awesome-list-item-->
111+
<!--lint ignore awesome-list-item double-link-->
112+
```
113+
87114
## How to add a new category
88115

89116
If you are creating a new category, move any relevant projects to that new category, while ensuring

0 commit comments

Comments
 (0)