Skip to content

Commit 637e289

Browse files
authored
fixes inspired by w3c-cg#17
typos, grammar, markup, etc.
1 parent 8fb25fa commit 637e289

File tree

1 file changed

+62
-47
lines changed

1 file changed

+62
-47
lines changed

CONTRIBUTING.md

Lines changed: 62 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -13,53 +13,55 @@ Please contribute links to packages/projects you have used or are familiar with.
1313

1414
To be on the list, project repositories should adhere to the following quality standards.
1515

16-
- have at least 5 months of history since the first commit.
17-
- function as documented and expected;
18-
- be generally useful to the wider Semantic Web community;
19-
- be actively maintained or not maintained anymore but finished and extremely useful (should be marked with ☠️);
20-
- be stable or progressing toward stable;
21-
- have at least one official version-numbered release;
22-
- be open source or commercial (marked with 💰) software.
16+
- have at least 5 months of history since the first commit
17+
- function as documented and expected
18+
- be generally useful to the wider Semantic Web community
19+
- be actively maintained or not maintained anymore but finished and extremely useful (should be marked with ☠️)
20+
- be stable or progressing toward stable
21+
- have at least one official version-numbered release
22+
- be open source or commercial (marked with 💰) software
2323

2424
Categories must have at least 3 items.
2525

2626
## How to add an item to the list
2727

2828
Open a pull request against the README.md document that adds the repository to the list.
2929

30-
- The pull request could add more than one item to the list.
31-
- The added items should respect sorting within its category:
32-
- by programming language first (if it is applicable),
33-
- and then in alphabetical order.
30+
- One pull request can add more than one item to the list
31+
- Each item should be added respecting sorting within its category
32+
- firstly, by programming language (if applicable)
33+
- secondly, in alphabetical order
3434

3535
## Item format
3636

3737
Non-software item must conform to the following format:
38-
39-
`<link> - <Description>.`
38+
```
39+
<link> - <Description>.
40+
```
4041

4142
Software item must conform to the following format:
43+
```
44+
<link> <activity info> - <Description>.
45+
```
4246

43-
`<link> <activity info> - <Description>.`
44-
45-
Where:
46-
- The link:
47-
- Should be the name of the package or project.
48-
- The hyperlink should point to a specific module related to the category (e.g. in case of 'SHACL Validators' section, use `https://github.com/apache/jena/tree/main/jena-shacl`, not `https://github.com/apache/jena`).
49-
- Activity info:
50-
- Should consists of two badges:
51-
- Latest known stable version badge (from any most common binary repository or GH Releases).
52-
- Recent repository activity badge.
53-
- Use `<img align="top">` badge format to better inline alignment.
54-
- Do not use any other badges (build status, dependencies, etc.).
55-
- Additional icons could be used to mark commercial 💰 or abandoned ☠️ software.
56-
- Description:
57-
- Should be clear, concise, and non-promotional.
58-
- Should begin with a capital letter.
59-
- May consist of several sentences.
60-
- Should be separated from the activity info with spaces and a dash ` - `.
61-
- Should contain license info and programming language at the end, formatted as `text in code quotes`.
62-
- 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.
47+
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`)
51+
- 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
58+
- 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
6365

6466
### Examples
6567

@@ -84,23 +86,36 @@ With a description:
8486

8587
## How to add a new category
8688

87-
If you are creating a new category, move the projects that apply to the new category, ensuring
88-
that the resulting list has at least 3 projects in every category, and that the categories are alphabetized.
89+
If you are creating a new category, move any relevant projects to that new category, while ensuring
90+
that every category in the resulting list has at least 3 projects, and that the categories are alphabetized.
8991

9092
## Updating your PR
9193

92-
A lot of times, making a PR adhere to the standards above can be difficult.
94+
It is often difficult to make a PR adhere to the standards above.
9395
If the maintainers notice anything that we'd like changed, we'll ask you to
94-
edit your PR before we merge it. There's no need to open a new PR, just edit
96+
edit your PR before we merge it. There's no need to open a new PR; just edit
9597
the existing one.
9698

97-
## Congrats, your project got accepted - what now?
98-
99-
You are an outstanding project now! Feel encouraged to tell others about it by adding one of these badges:
100-
[![Mentioned in Awesome Semantic Shapes](https://awesome.re/mentioned-badge.svg)](https://github.com/w3c-cg/awesome-semantic-shapes)
101-
[![Mentioned in Awesome Semantic Shapes](https://awesome.re/mentioned-badge-flat.svg)](https://github.com/w3c-cg/awesome-semantic-shapes)
102-
103-
```md
104-
[![Mentioned in Awesome Semantic Shapes](https://awesome.re/mentioned-badge.svg)](https://github.com/w3c-cg/awesome-semantic-shapes)
105-
[![Mentioned in Awesome Semantic Shapes](https://awesome.re/mentioned-badge-flat.svg)](https://github.com/w3c-cg/awesome-semantic-shapes)
106-
```
99+
## Congratulations, your project got accepted — what now?
100+
101+
You are an outstanding project now! We encourage you to tell others about it
102+
by adding one of these badges to your project webpage(s):
103+
- [![Mentioned in Awesome Semantic Shapes](https://awesome.re/mentioned-badge.svg)](https://github.com/w3c-cg/awesome-semantic-shapes)
104+
- ```md
105+
[![Mentioned in Awesome Semantic Shapes](https://awesome.re/mentioned-badge.svg)](https://github.com/w3c-cg/awesome-semantic-shapes)
106+
```
107+
- ```html
108+
<a href="https://github.com/w3c-cg/awesome-semantic-shapes">
109+
<img src="https://awesome.re/mentioned-badge.svg" alt="Mentioned in Awesome Semantic Shapes" style="max-width: 100%;">
110+
</a>
111+
```
112+
113+
- [![Mentioned in Awesome Semantic Shapes](https://awesome.re/mentioned-badge-flat.svg)](https://github.com/w3c-cg/awesome-semantic-shapes)
114+
- ```md
115+
[![Mentioned in Awesome Semantic Shapes](https://awesome.re/mentioned-badge-flat.svg)](https://github.com/w3c-cg/awesome-semantic-shapes)
116+
```
117+
- ```html
118+
<a href="https://github.com/w3c-cg/awesome-semantic-shapes">
119+
<img src="https://awesome.re/mentioned-badge-flat.svg" alt="Mentioned in Awesome Semantic Shapes" style="max-width: 100%;">
120+
</a>
121+
```

0 commit comments

Comments
 (0)