|
1 |
| -# SHACL Community Group |
| 1 | +# Contribution Guidelines |
2 | 2 |
|
3 |
| -This repository is being used for work in the W3C SHACL Community Group, governed by the [W3C Community License |
4 |
| -Agreement (CLA)](http://www.w3.org/community/about/agreements/cla/). To make substantive contributions, |
5 |
| -you must join the CG. |
| 3 | +Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). |
| 4 | +By participating in this project you agree to abide by its terms. |
6 | 5 |
|
7 |
| -If you are not the sole contributor to a contribution (pull request), please identify all |
8 |
| -contributors in the pull request comment. |
| 6 | +This repository is governed by the [CC0 license](https://creativecommons.org/publicdomain/zero/1.0/). |
9 | 7 |
|
10 |
| -To add a contributor (other than yourself, that's automatic), mark them one per line as follows: |
| 8 | +To add, remove, or change things on the list: **Submit a pull request**. |
11 | 9 |
|
| 10 | +## Quality standards |
| 11 | + |
| 12 | +Please contribute links to packages/projects you have used or are familiar with. This will help ensure high-quality entries. |
| 13 | + |
| 14 | +To be on the list, project repositories should adhere to the following quality standards. |
| 15 | + |
| 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. |
| 23 | + |
| 24 | +Categories must have at least 3 items. |
| 25 | + |
| 26 | +## How to add an item to the list |
| 27 | + |
| 28 | +Open a pull request against the README.md document that adds the repository to the list. |
| 29 | + |
| 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. |
| 34 | + |
| 35 | +## Item format |
| 36 | + |
| 37 | +Non-software item must conform to the following format: |
| 38 | + |
| 39 | +`<link> - <Description>.` |
| 40 | + |
| 41 | +Software item must conform to the following format: |
| 42 | + |
| 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. |
| 63 | + |
| 64 | +### Examples |
| 65 | + |
| 66 | +#### Non-software items |
| 67 | + |
| 68 | +Without a description: |
| 69 | + |
| 70 | +```markdown |
| 71 | +- [SHACL 1.2 Core](https://w3c.github.io/shacl/shacl-core/) |
12 | 72 | ```
|
13 |
| -+@github_username |
| 73 | + |
| 74 | +With a description: |
| 75 | +```markdown |
| 76 | +- [Validating RDF Data (2018)](https://book.validatingrdf.com) - The SHACL and ShEx book. |
14 | 77 | ```
|
15 | 78 |
|
16 |
| -If you added a contributor by mistake, you can remove them in a comment with: |
| 79 | +#### Software module item with a description |
17 | 80 |
|
| 81 | +```markdown |
| 82 | +- [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`. |
18 | 83 | ```
|
19 |
| --@github_username |
20 |
| -``` |
21 | 84 |
|
22 |
| -If you are making a pull request on behalf of someone else but you had no part in designing the |
23 |
| -feature, you can remove yourself with the above syntax. |
| 85 | +## How to add a new category |
| 86 | + |
| 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 | + |
| 90 | +## Updating your PR |
| 91 | + |
| 92 | +A lot of times, making a PR adhere to the standards above can be difficult. |
| 93 | +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 |
| 95 | +the existing one. |
| 96 | + |
| 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 | +[](https://github.com/w3c-cg/awesome-semantic-shapes) |
| 101 | +[](https://github.com/w3c-cg/awesome-semantic-shapes) |
| 102 | + |
| 103 | +```md |
| 104 | +[](https://github.com/w3c-cg/awesome-semantic-shapes) |
| 105 | +[](https://github.com/w3c-cg/awesome-semantic-shapes) |
| 106 | +``` |
0 commit comments