From 680111db7486ddced1da87be27d53183729beaf6 Mon Sep 17 00:00:00 2001 From: Sarven Capadisli Date: Tue, 29 Mar 2022 01:43:10 +0200 Subject: [PATCH 01/13] Add contributing guide. Closes #387 --- CONTRIBUTING.md | 228 ++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 4 + 2 files changed, 232 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..a62249e6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,228 @@ +# Solid Technical Reports Contributing Guide + +Thank you for investing your time into contributing to the Solid project! + +This repository contains the source code of the work on [Solid Technical +Reports](https://solidproject.org/TR/) (TR) of the [W3C Solid Community +Group](https://www.w3.org/community/solid/) (CG) to meet the needs of the [Solid +Project](https://solidproject.org/). + +The TRs include specifications, use cases and requirements, best practices and +guidelines, primers and notes about the Solid ecosystem. + + +## Code of Conduct + +Read the [Solid Code of +Conduct](https://github.com/solid/process/blob/main/code-of-conduct.md) and the +[Positive Work Environment at W3C: Code of Ethics and Professional +Conduct](https://www.w3.org/Consortium/cepc/) to keep our community approachable +and respectable. + + +## Contributions + +All substantive contributors must be members of the CG. It’s easy to [join the +CG](https://www.w3.org/community/solid/join) if you’d like to contribute. People +agree to the [W3C Community License Agreement +(CLA)](http://www.w3.org/community/about/agreements/cla/) upon joining the the +CG. + +The works in this repository use the [MIT +license](https://github.com/solid/specification/blob/main/LICENSE.md). + +We accept different types of contributions, including some that don't require +you to write a single line of code: + +### Discussions + +If you'd like help troubleshooting a pull request you're working on, have a +great new idea, or want to share implementation feedback, join us in [Solid +specification chat](https://gitter.im/solid/specification). + +### Issues + +[Issues](https://docs.github.com/en/github/managing-your-work-on-github/about-issues) +are used to track tasks that contributors can help with. If an issue has a +triage label, we haven't reviewed it yet and you shouldn't begin work on it. + +If you've found something in the content or the website that should be updated, +search open issues to see if someone else has reported the same thing. If it's +something new, open an issue. We'll use the issue to have a conversation about +the problem you want to fix. + +### Pull requests + +A [pull +request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) +is a way to suggest changes in our repository. + +### Translations + +We aim to have our documents internationalized and available in multiple +languages. The source content in this repository is written in English. We +accept contributions to localize the English content. + + +## Issues + +How to create and solve issues: + +### Create a new issue + +If you spot a problem with the technical reports published in this repository or +would like to request a feature, [search if an issue already +exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). +If a related issue doesn't exist, you can open a new issue. In the issue, +include relevant information that can help others, e.g., links to +specifications, issues, implementations, test suite, discussions. + +### Solve an issue + +Scan through our [existing +issues](https://github.com/solid/specification/issues/) to find one that +interests you. You can narrow down the search using `labels` as filters. See +[Labels](https://github.com/github/docs/blob/main/contributing/how-to-use-labels.md) +for more information. If you find an issue to work on, you are welcome to open a +pull request (PR) with a fix. + + +## Make changes + +### Make changes locally + +1. Install Git +2. Fork the repository. +3. Create a working branch and start with your changes! + + +## Commit your update + +Commit the changes once you are happy with them. See [Atom's contributing +guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages) +to know how to use emoji for commit messages. + +Once your changes are ready, don't forget to [self-review](#self-review) to +speed up the review process:zap:. + +### Self-review + +You should always review your own PR first. + +For content changes, make sure that you: + +* [ ] Confirm that the changes meet the user experience and goals outlined in + the content design plan (if there is one). +* [ ] Compare your pull request's source changes to staging to confirm that the + output matches the source and that everything is rendering as expected. +* [ ] Review the content for technical accuracy. +* [ ] Review the entire pull request using the [localization + checklist](https://github.com/github/docs/blob/main/contributing/localization-checklist.md) + and the [W3C Manual of Style](https://www.w3.org/2001/06/manual/) as guides. +* [ ] If there are any failing checks in your PR, troubleshoot them until + they're all passing. + + +## Creating a pull request + +When you're finished with the changes, create a pull request, also known as a +PR. + +* Include atomic commits, small PRs: "one concern, one PR". +* In the PR comment, provide as much context to help reviewers evaluate the PR. +* Don't forget to [link PR to + issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) + if you are solving one. +* We may ask for changes to be made before a PR can be merged, either using + [suggested + changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) + or pull request comments. You can apply suggested changes directly through the + UI. You can make any other changes in your fork, then commit them to your + branch. +* As you update your PR and apply changes, mark each conversation as + [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations). +* If you run into any merge issues, checkout this [git + tutorial](https://lab.github.com/githubtraining/managing-merge-conflicts) to + help you resolve merge conflicts and other issues. +* If you are not the sole contributor, please identify all contributors in the + pull request comment. To add a contributor (other than yourself), mark the one + per line as follows: `+@github_username`. + +### Your PR is merged! + +Congratulations :tada: Solid community thanks you :sparkles:. + + + +## Publishing a technical report + +This section describes how to prepare the technical reports and how they'll be +published on the Solid website. + +### General guidance + +* Content: the full content of the technical report must be human-readable with + HTML alone. Any CSS and JavaScript should not interfere with the accessibility + of the content. +* Offline-friendly: there must not be any external dependencies (e.g., a network + connection) to retrieve, to render, or to manipulate the content of the + article. +* Privacy: scripts must not be used to identify or track readers. + +There are two parts to publishing a technical report that applies to all +reports: + +1. PR including the technical report in HTML and all local script and media + files. +2. Updating the technical report index (if necessary). + +Published documents will be publicly accessible under the paths +`https://solidproject.org/TR/` or `https://solidproject.org/ED/`. + +### Versioned technical report + +The PR for a versioned technical report must include two HTML documents: + +1. "Latest version" of the TR under the root (`/`) directory. +2. "Persistent version" of the TR under the `/{yyyy}/` (year in 4 digits) + directory. + +We recommend that the latest version of the technical reports use a +`{shortname}`, e.g., `protocol`, `wac`, and the persistent version of the +technical report follows the following form: `{shortname}-{yyyymmdd}`. + +All files use common file name extensions, e.g., `.html`. + +The documents will be published under the path `https://solidproject.org/TR/`. + +For example, the *Solid Protocol* is available from the following URLs: +* Latest version: https://solidproject.org/TR/protocol +* Persistent version: https://solidproject.org/TR/2021/protocol-20211217 + +When a new version of the technical report is made available, we follow the same +process. The new "latest version" will then link to the new "persistent +version". Every persistent version will link to the latest version. + +### Non-versioned technical report + +The PR for a non-versioned technical report must include one HTML document and +follow the same requirements as in "latest version" (see [versioned technical +report](#versioned-technical-report)). + +The documents will be published under the path `https://solidproject.org/TR/`. + +### Editor's draft + +The PR for a non-versioned technical report must include one HTML document and +follow the same requirements as in "latest version" (see [versioned technical +report](#versioned-technical-report)). + +The document will be published under the path `https://solidproject.org/ED/`. +For example, the Editor's Draft of the *Solid Protocol* is available from +https://solidproject.org/ED/protocol . + +## Technical Report index + +When a new technical report is added, removed, or the status of the document is +modified, a PR should include an update to the [Technical Report +index](https://github.com/solid/specification/blob/main/index.html). diff --git a/README.md b/README.md index d47cdeea..3815a606 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,10 @@ Solid Panels focus on specific problems, with an aim to propose technical report * https://github.com/solid/notifications-panel * https://github.com/solid/test-suite +## Contributing + +See the [contributing guide](https://github.com/solid/specification/blob/main/CONTRIBUTING.md) for detailed instructions on how to get started with our project. + ## Code of Conduct All work and communication within the Solid CG is covered by the [Solid Code of Conduct](https://github.com/solid/process/blob/main/code-of-conduct.md) as well as the [Positive Work Environment at W3C: Code of Ethics and Professional Conduct](https://www.w3.org/Consortium/cepc/). From 228b3551938d6dc842afc44b2711e5a76d99e4fe Mon Sep 17 00:00:00 2001 From: Sarven Capadisli Date: Tue, 29 Mar 2022 09:24:53 +0200 Subject: [PATCH 02/13] Minor --- CONTRIBUTING.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a62249e6..f46dea61 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,8 +25,7 @@ and respectable. All substantive contributors must be members of the CG. It’s easy to [join the CG](https://www.w3.org/community/solid/join) if you’d like to contribute. People agree to the [W3C Community License Agreement -(CLA)](http://www.w3.org/community/about/agreements/cla/) upon joining the the -CG. +(CLA)](http://www.w3.org/community/about/agreements/cla/) upon joining the CG. The works in this repository use the [MIT license](https://github.com/solid/specification/blob/main/LICENSE.md). @@ -64,9 +63,7 @@ languages. The source content in this repository is written in English. We accept contributions to localize the English content. -## Issues - -How to create and solve issues: +## Creating and solving issues ### Create a new issue @@ -129,7 +126,8 @@ When you're finished with the changes, create a pull request, also known as a PR. * Include atomic commits, small PRs: "one concern, one PR". -* In the PR comment, provide as much context to help reviewers evaluate the PR. +* In the PR comment, provide as much context and evidence to help reviewers + evaluate the PR. * Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one. @@ -145,7 +143,7 @@ PR. tutorial](https://lab.github.com/githubtraining/managing-merge-conflicts) to help you resolve merge conflicts and other issues. * If you are not the sole contributor, please identify all contributors in the - pull request comment. To add a contributor (other than yourself), mark the one + pull request comment. To add a contributor (other than yourself), mark them one per line as follows: `+@github_username`. ### Your PR is merged! @@ -223,6 +221,6 @@ https://solidproject.org/ED/protocol . ## Technical Report index -When a new technical report is added, removed, or the status of the document is -modified, a PR should include an update to the [Technical Report -index](https://github.com/solid/specification/blob/main/index.html). +When a new technical report is added, information about it is modified, or a +new work item is being worked on by the CG, a PR should update the [Technical +Report index](https://github.com/solid/specification/blob/main/index.html). From c440a5aa2bc179a29f75087e5a0230a13785e593 Mon Sep 17 00:00:00 2001 From: Sarven Capadisli Date: Tue, 29 Mar 2022 09:55:40 +0200 Subject: [PATCH 03/13] Add contributions-at-source-repository --- CONTRIBUTING.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f46dea61..f56d33fd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -63,12 +63,21 @@ languages. The source content in this repository is written in English. We accept contributions to localize the English content. +## Contributions at source repository + +Technical reports published at this repository are intended to be read-only +snapshots of the CG work items. + +Each work item may have its own original repository any issues and PRs should +be made there (instead of this repository `solid/specification`). + + ## Creating and solving issues ### Create a new issue -If you spot a problem with the technical reports published in this repository or -would like to request a feature, [search if an issue already +If you spot a problem with the technical reports being worked on in this +repository or would like to request a feature, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue. In the issue, include relevant information that can help others, e.g., links to @@ -122,8 +131,8 @@ For content changes, make sure that you: ## Creating a pull request -When you're finished with the changes, create a pull request, also known as a -PR. +When you're finished with the changes to documents that are maintained in this +repository, create a pull request, also known as a PR. * Include atomic commits, small PRs: "one concern, one PR". * In the PR comment, provide as much context and evidence to help reviewers From 614f86dfcb52ac210ddff0f75f337cc54be6d664 Mon Sep 17 00:00:00 2001 From: Sarven Capadisli Date: Tue, 29 Mar 2022 09:56:24 +0200 Subject: [PATCH 04/13] Mention W3C htmldiff service --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f56d33fd..5023962f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -120,7 +120,9 @@ For content changes, make sure that you: * [ ] Confirm that the changes meet the user experience and goals outlined in the content design plan (if there is one). * [ ] Compare your pull request's source changes to staging to confirm that the - output matches the source and that everything is rendering as expected. + output matches the source and that everything is rendering as expected. The + W3C service to [creating diff between HTML pages](https://services.w3.org/htmldiff) + can also be used. * [ ] Review the content for technical accuracy. * [ ] Review the entire pull request using the [localization checklist](https://github.com/github/docs/blob/main/contributing/localization-checklist.md) From e0fb598772678192bd65c0a779024333541c0d2d Mon Sep 17 00:00:00 2001 From: Sarven Capadisli Date: Tue, 29 Mar 2022 10:02:18 +0200 Subject: [PATCH 05/13] Minor --- CONTRIBUTING.md | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5023962f..5466d736 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ The TRs include specifications, use cases and requirements, best practices and guidelines, primers and notes about the Solid ecosystem. -## Code of Conduct +## Code of conduct Read the [Solid Code of Conduct](https://github.com/solid/process/blob/main/code-of-conduct.md) and the @@ -35,7 +35,7 @@ you to write a single line of code: ### Discussions -If you'd like help troubleshooting a pull request you're working on, have a +If you'd like help troubleshooting a pull request (PR) you're working on, have a great new idea, or want to share implementation feedback, join us in [Solid specification chat](https://gitter.im/solid/specification). @@ -68,8 +68,8 @@ accept contributions to localize the English content. Technical reports published at this repository are intended to be read-only snapshots of the CG work items. -Each work item may have its own original repository any issues and PRs should -be made there (instead of this repository `solid/specification`). +Each work item may have its own original repository and any issues and PRs +should be made there (instead of this repository `solid/specification`). ## Creating and solving issues @@ -89,8 +89,8 @@ Scan through our [existing issues](https://github.com/solid/specification/issues/) to find one that interests you. You can narrow down the search using `labels` as filters. See [Labels](https://github.com/github/docs/blob/main/contributing/how-to-use-labels.md) -for more information. If you find an issue to work on, you are welcome to open a -pull request (PR) with a fix. +for more information. If you find an issue to work on, you are welcome to open +a PR with a fix. ## Make changes @@ -119,12 +119,12 @@ For content changes, make sure that you: * [ ] Confirm that the changes meet the user experience and goals outlined in the content design plan (if there is one). -* [ ] Compare your pull request's source changes to staging to confirm that the +* [ ] Compare your PR's source changes to staging to confirm that the output matches the source and that everything is rendering as expected. The W3C service to [creating diff between HTML pages](https://services.w3.org/htmldiff) can also be used. * [ ] Review the content for technical accuracy. -* [ ] Review the entire pull request using the [localization +* [ ] Review the entire PR using the [localization checklist](https://github.com/github/docs/blob/main/contributing/localization-checklist.md) and the [W3C Manual of Style](https://www.w3.org/2001/06/manual/) as guides. * [ ] If there are any failing checks in your PR, troubleshoot them until @@ -134,7 +134,7 @@ For content changes, make sure that you: ## Creating a pull request When you're finished with the changes to documents that are maintained in this -repository, create a pull request, also known as a PR. +repository, create a PR. * Include atomic commits, small PRs: "one concern, one PR". * In the PR comment, provide as much context and evidence to help reviewers @@ -145,17 +145,16 @@ repository, create a pull request, also known as a PR. * We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) - or pull request comments. You can apply suggested changes directly through the - UI. You can make any other changes in your fork, then commit them to your - branch. + or PR comments. You can apply suggested changes directly through the UI. You + can make any other changes in your fork, then commit them to your branch. * As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations). * If you run into any merge issues, checkout this [git tutorial](https://lab.github.com/githubtraining/managing-merge-conflicts) to help you resolve merge conflicts and other issues. * If you are not the sole contributor, please identify all contributors in the - pull request comment. To add a contributor (other than yourself), mark them one - per line as follows: `+@github_username`. + PR comment. To add a contributor (other than yourself), mark them one per + line as follows: `+@github_username`. ### Your PR is merged! From dfb7ca078730ce5f7521db704a8fce9310bb95d6 Mon Sep 17 00:00:00 2001 From: Sarven Capadisli Date: Tue, 29 Mar 2022 13:19:21 +0200 Subject: [PATCH 06/13] Minor --- CONTRIBUTING.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5466d736..6aa1c02c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,16 +22,15 @@ and respectable. ## Contributions -All substantive contributors must be members of the CG. It’s easy to [join the -CG](https://www.w3.org/community/solid/join) if you’d like to contribute. People -agree to the [W3C Community License Agreement +In order to be a substantive contributor to work items, you must be a member of +the CG. It’s easy to [join the CG](https://www.w3.org/community/solid/join) if +you’d like to contribute. People agree to the [W3C Community License Agreement (CLA)](http://www.w3.org/community/about/agreements/cla/) upon joining the CG. The works in this repository use the [MIT license](https://github.com/solid/specification/blob/main/LICENSE.md). -We accept different types of contributions, including some that don't require -you to write a single line of code: +We accept different types of contributions as described below. ### Discussions From 3e838fb85455fd4caed9057c5ad599eed5b8eb2a Mon Sep 17 00:00:00 2001 From: Sarven Capadisli Date: Tue, 29 Mar 2022 13:19:58 +0200 Subject: [PATCH 07/13] Update CONTRIBUTING.md Co-authored-by: Ruben Verborgh --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6aa1c02c..f74af4bf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -171,7 +171,7 @@ published on the Solid website. * Content: the full content of the technical report must be human-readable with HTML alone. Any CSS and JavaScript should not interfere with the accessibility of the content. -* Offline-friendly: there must not be any external dependencies (e.g., a network +* Offline-friendly: there must not be any mandatory external dependencies (e.g., a network connection) to retrieve, to render, or to manipulate the content of the article. * Privacy: scripts must not be used to identify or track readers. From de4cdfada16f9efd64d2274ccaffb044b4c5d221 Mon Sep 17 00:00:00 2001 From: Sarven Capadisli Date: Tue, 29 Mar 2022 17:54:14 +0200 Subject: [PATCH 08/13] Minor --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f74af4bf..f853332f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -64,12 +64,12 @@ accept contributions to localize the English content. ## Contributions at source repository -Technical reports published at this repository are intended to be read-only -snapshots of the CG work items. - -Each work item may have its own original repository and any issues and PRs -should be made there (instead of this repository `solid/specification`). +Each CG work item has its own repository and any issues and PRs should be made +at their source. +The latest and persistent version of technical reports (see [publishing +technical reports](#publishing-technical-reports) published at this repository +are intended to be read-only snapshots of the CG work items. ## Creating and solving issues From a79df64b2681584fe53af7477ebffea2c39c0c93 Mon Sep 17 00:00:00 2001 From: Sarven Capadisli Date: Tue, 29 Mar 2022 17:54:41 +0200 Subject: [PATCH 09/13] Mention solid-panels --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f853332f..fa65cefa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -71,6 +71,12 @@ The latest and persistent version of technical reports (see [publishing technical reports](#publishing-technical-reports) published at this repository are intended to be read-only snapshots of the CG work items. +[Solid +Panels](https://github.com/solid/specification/blob/main/README.md#solid-panels) +focus on certain work streams, with an aim to propose technical reports for +the Solid ecosystem. + + ## Creating and solving issues ### Create a new issue From 1b63a933e8ea948555e2d07d6bf3968305051bbc Mon Sep 17 00:00:00 2001 From: Sarven Capadisli Date: Fri, 1 Apr 2022 19:30:02 +0200 Subject: [PATCH 10/13] Update CONTRIBUTING.md Co-authored-by: Ted Thibodeau Jr --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fa65cefa..c39b522c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Solid Technical Reports Contributing Guide -Thank you for investing your time into contributing to the Solid project! +Thank you for investing your time in contribution to the Solid project! This repository contains the source code of the work on [Solid Technical Reports](https://solidproject.org/TR/) (TR) of the [W3C Solid Community From 8c3ae506180d150bb3518a4f9df4085066d0d3b0 Mon Sep 17 00:00:00 2001 From: Sarven Capadisli Date: Fri, 1 Apr 2022 20:37:26 +0200 Subject: [PATCH 11/13] Minor --- CONTRIBUTING.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c39b522c..87115dd1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -64,12 +64,13 @@ accept contributions to localize the English content. ## Contributions at source repository -Each CG work item has its own repository and any issues and PRs should be made -at their source. +Each CG work item listed at [Solid Technical +Reports](https://solidproject.org/TR/) has its own repository and any issues +and PRs should be made at their source. -The latest and persistent version of technical reports (see [publishing -technical reports](#publishing-technical-reports) published at this repository -are intended to be read-only snapshots of the CG work items. +The persistent version of technical reports published in this repository (see +[publishing technical reports](#publishing-technical-reports) are intended to +be read-only snapshots of the CG work items. [Solid Panels](https://github.com/solid/specification/blob/main/README.md#solid-panels) From 907ca5ad97d8d65144b395a264f5442b62621438 Mon Sep 17 00:00:00 2001 From: Sarven Capadisli Date: Fri, 1 Apr 2022 20:53:42 +0200 Subject: [PATCH 12/13] Add user-stories --- CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 87115dd1..d6bafb91 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -77,6 +77,9 @@ Panels](https://github.com/solid/specification/blob/main/README.md#solid-panels) focus on certain work streams, with an aim to propose technical reports for the Solid ecosystem. +To build shared understanding, [user +stories](https://github.com/solid/user-stories) can also be submitted. + ## Creating and solving issues From 1393c8abd5ef06f4917cf79782a948aa82f5556e Mon Sep 17 00:00:00 2001 From: Sarven Capadisli Date: Sat, 2 Apr 2022 10:54:28 +0200 Subject: [PATCH 13/13] Update CONTRIBUTING.md Co-authored-by: Kjetil Kjernsmo --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d6bafb91..3b5c6b50 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -77,8 +77,8 @@ Panels](https://github.com/solid/specification/blob/main/README.md#solid-panels) focus on certain work streams, with an aim to propose technical reports for the Solid ecosystem. -To build shared understanding, [user -stories](https://github.com/solid/user-stories) can also be submitted. +A low-barrier way to add concrete suggestions is to submit a [user +story](https://github.com/solid/user-stories). User stories are descriptions of desired features written in a special way, see the description there for details. User stories may then be used when formulating use cases and requirements. ## Creating and solving issues