From b3ea71ee3faad899fd5a788169d2559f2d08e1ac Mon Sep 17 00:00:00 2001 From: Arne Hassel Date: Mon, 4 Mar 2024 12:23:26 +0100 Subject: [PATCH 01/12] Adding CONTRIBUTING.md as a starting point for discussing processes This PR is my attempt at resolving https://github.com/solid/team/issues/69 The resource is inspired by https://github.com/w3c-cg/solid/blob/main/CONTRIBUTING.md and https://www.w3.org/Consortium/Process/#decisions. Moved some stuff from README.md to CONTRIBUTING.md. --- CONTRIBUTING.md | 161 ++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 8 +-- 2 files changed, 164 insertions(+), 5 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9103cb7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,161 @@ +# Solid Team Contributing Guide + +[The Solid Team](team.md) is headed by Sir Tim Berners-Lee and provides an organisational umbrella for facilitating a +strong open source community in support of Solid. This repository contains work of the Solid Team to meet the needs of +the [Solid Project](https://solidproject.org/). + +The Solid Team is a group of volunteers tasked with representing the Solid Project in an official capacity. It engages +in activities that foster the spread and adoption of the Solid protocol. + +## Code of Conduct + +The Solid Team follows +the [Solid Community Code of Conduct](https://github.com/solid/process/blob/main/code-of-conduct.md). + +## How to join the team + +Anyone can become a member of the Solid Team. Check out the [team.md](team.md) for more information about how to join +the team. + +## How the team works + +Solid Team consists of volunteers, lead by Sir Tim Berners-Lee. The group operates mostly as +a [do-ocracy](https://communitywiki.org/wiki/DoOcracy), where tasks are assigned by members taking on responsibility +themselves. Members are required to adhere to [teams' decisions](#decisions). + +### Tasks + +The Solid Team engages in a number of [tasks](tasks). Tasks may be added or removed from the team's scope by majority +vote at a Solid Team meeting. ### Task Force Membership Team members may be added or removed from this task force by a +majority vote at a Solid Team meeting. There must be a lead for this task. While other members may assist in the task, +it is the responsibility of the leader to follow up on the task and report updates to the team. + +### Meetings + +The Solid Team holds meetings at on every second Wednesday of the month at 15:00 UTC - +subscribe to [vCalendar](https://raw.githubusercontent.com/solid/team/main/meetings/calendar.ics). Meetings are +transcribed and [published](meetings). Additional team meetings may be created, in which case Solid Team members will be +notified via calendar invitation and in the Solid Team chat. + +### 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. Issues are mostly grouped +into [task forces](README.md#ongoing-task-forces), so you should join one of them if you want to collaborate with +others. + +### 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. + +### Decisions + +The team's decision process is inspired by +the [chapter on decisions in W3C Process Document](https://www.w3.org/Consortium/Process/#decisions). + +The team attempts to resolve issues through dialog. Individuals who disagree strongly with a decision should register +with the leader any formal objections. + +Any substantive issues that can't be resolved through reaching consensus through technical discussions and compromise +must go through a vote, and the results must be public. Decisions may be made during [meetings](./meetings) +(face-to-face or distributed) as well as through persistent text-based discussions. + +Each member has one vote. The leader has a double vote if there's a tie. A decision requires the majority (i.e. at least +50%) of the votes amongst the attendees, and at least 50% of all members must attend a decision for it to be valid. ( +E.g. if there are 12 members overall, at least 6 must attend a meeting for it to be possible to make decisions in that +meeting. Of these, at least 4 of the votes are required for a decision.) + +The leader can require decisions to need a supermajority, which means that a minimum of 50% of eligible voters must vote +for a decision to be made. (E.g. if there are 12 members overall, at least 6 of their votes are required for a decision +to be made.) + +Individuals might abstain. Abstention is either an explicit expression of no opinion or silence by an individual in the +set. + +### Communication + +The opinions of team members may carry particular weight, whether they are expressed within our community or elsewhere. +As a team member: + +* It is assumed you are speaking as an individual unless you state otherwise. +* If you want to express the opinion of your organisation or a group you are affiliated with, make it clear before you + state their view. +* Do not use phrases like "on behalf of the team" or "the team thinks that" unless the group has asked you to do so. +* When communicating team decisions, provide references to what was decided and what was not decided. + +### Transparency + +Team members represent the overall Solid efforts, and so should strive to make their efforts transparent. This is mostly +done by communicating substantial efforts and changes through [issues](#issues) and [pull requests](#pull-requests). In +cases where full transparency is counterproductive (e.g. ongoing efforts include tools where public access is not +possible or costly), efforts should be made to mitigate these constraints as efficient as possible. + +## 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 are strongly encouraged to review your own PR first. + +* [ ] 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 content to use [inclusive + language](https://github.com/github/docs/blob/main/contributing/content-style-guide.md#inclusive-language). + Celebrate people/names from under represented ethnic/cultural backgrounds in + examples, e.g., [unique forenames in + Earth](https://forebears.io/earth/forenames), [example person + names](https://developers.google.com/style/examples#example-person-names). + +## Creating a pull request + +When you're finished with the changes to documents that are maintained in this +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 + evaluate the PR. Identify, classify, describes the changes as per W3C + Process [Correction + Classes](https://www.w3.org/Consortium/Process/#correction-classes). +* 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 can 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 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. +* You can attribute a commit to more than one author by adding one or more + `Co-authored-by: NAME ` per line to commit's message + (after two empty lines). See [github + tutorial](https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors). +* To help maintain a clean Git history, consider using [squash + merge](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github#squashing-your-merge-commits) + for PRs, especially when incorporating reviews and code additions. + +### Your PR is merged! + +Congratulations :tada: The Solid Team and the community thanks you :sparkles: \ No newline at end of file diff --git a/README.md b/README.md index 561ef55..85b2501 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,8 @@ The Solid Team has a (member-only) [chat](https://gitter.im/solid/team). The Solid Team holds meetings at on every second Wednesday of the month at 15:00 UTC - subscribe to [vCalendar](https://raw.githubusercontent.com/solid/team/main/meetings/calendar.ics). Meetings are transcribed and [published](https://github.com/solid/team/tree/main/meetings/). Additional team meetings may be created, in which case Solid Team members will be notified via calendar invitation and in the Solid Team chat. +To know more about how to contribute, check [CONTRIBUTING.md](https://github.com/solid/team/tree/main/CONTRIBUTING.md). + ## Membership [Membership Information](/team.md) @@ -22,11 +24,7 @@ The Solid Team follows the [Solid Community Code of Conduct](https://github.com/ ## Tasks -The Solid Team engages in a number of tasks. Tasks may be added or removed from the team's scope by majority vote at a Solid Team meeting. A blocked task is a tast that the team wants to do, but currently doesn't have the resources to do. - -### Task Force Membership - -Team members may be added or removed from this task force by a majority vote at a Solid Team meeting. There must be a lead for this task. While other members may assist in the task, it is the responsibility of the leader to +The Solid Team engages in a number of tasks. A blocked task is a task that the team wants to do, but currently doesn't have the resources to do. ### Ongoing Task Forces From 3c64ac4d2828f8aa1febcd36fda62bbcb58f6a73 Mon Sep 17 00:00:00 2001 From: Arne Hassel Date: Mon, 4 Mar 2024 12:34:13 +0100 Subject: [PATCH 02/12] Added list of collaborators --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 85b2501..940a287 100644 --- a/README.md +++ b/README.md @@ -48,3 +48,12 @@ The Solid Team engages in a number of tasks. A blocked task is a task that the t * [Create a Better Onboarding Experience for Developers](/tasks/developer-onboarding-experience.md) * [Create a Better Onboarding Experience for Users](/tasks/user-onboarding-experience.md) * [SolidProject.org Content Pass](/tasks/solid-project-content-pass.md) + +## Collaborations + +The team collaborates with a lot of other Solid groups, such as: + +* [Solid Community Group](https://www.w3.org/groups/cg/solid/) +* Solid Work Group +* [Solid Creators](https://github.com/solid/process/blob/main/creators.md) +* [Code of Conduct Committee](https://github.com/solid/process/blob/main/code-of-conduct.md) From 695be7333fbd212d23f51c7ddf102c176fcdb0c9 Mon Sep 17 00:00:00 2001 From: Arne Hassel Date: Mon, 4 Mar 2024 17:24:27 +0100 Subject: [PATCH 03/12] 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 9103cb7..81e37df 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Solid Team Contributing Guide -[The Solid Team](team.md) is headed by Sir Tim Berners-Lee and provides an organisational umbrella for facilitating a +[The Solid Team](team.md) is headed by Sir Tim Berners-Lee and provides an organisational umbrella to facilitate a strong open source community in support of Solid. This repository contains work of the Solid Team to meet the needs of the [Solid Project](https://solidproject.org/). From b9022438b3d798557c30d379b1af1f0628122a8a Mon Sep 17 00:00:00 2001 From: Arne Hassel Date: Mon, 4 Mar 2024 17:26:28 +0100 Subject: [PATCH 04/12] Update CONTRIBUTING.md Co-authored-by: Ted Thibodeau Jr --- CONTRIBUTING.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 81e37df..1e428aa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,7 +26,11 @@ themselves. Members are required to adhere to [teams' decisions](#decisions). ### Tasks The Solid Team engages in a number of [tasks](tasks). Tasks may be added or removed from the team's scope by majority -vote at a Solid Team meeting. ### Task Force Membership Team members may be added or removed from this task force by a +vote at a Solid Team meeting. + +### Task Force Membership + +Team members may be added or removed from this task force by a majority vote at a Solid Team meeting. There must be a lead for this task. While other members may assist in the task, it is the responsibility of the leader to follow up on the task and report updates to the team. From 1e92f73dbf3d25fc774825c34c2703ff363e9fde Mon Sep 17 00:00:00 2001 From: Arne Hassel Date: Mon, 4 Mar 2024 17:26:37 +0100 Subject: [PATCH 05/12] 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 1e428aa..de88149 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,7 +36,7 @@ it is the responsibility of the leader to follow up on the task and report updat ### Meetings -The Solid Team holds meetings at on every second Wednesday of the month at 15:00 UTC - +The Solid Team holds meetings at on every second Wednesday of the month at 15:00 UTC β€” subscribe to [vCalendar](https://raw.githubusercontent.com/solid/team/main/meetings/calendar.ics). Meetings are transcribed and [published](meetings). Additional team meetings may be created, in which case Solid Team members will be notified via calendar invitation and in the Solid Team chat. From 4c0ddbe98e7499a4be0ddb982499b59c05a34725 Mon Sep 17 00:00:00 2001 From: Arne Hassel Date: Mon, 4 Mar 2024 17:26:47 +0100 Subject: [PATCH 06/12] Update README.md Co-authored-by: Ted Thibodeau Jr --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 940a287..3184c01 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ All substantive contributors must be members of the Solid Team. It’s easy to [ The Solid Team has a (member-only) [chat](https://gitter.im/solid/team). -The Solid Team holds meetings at on every second Wednesday of the month at 15:00 UTC - subscribe to [vCalendar](https://raw.githubusercontent.com/solid/team/main/meetings/calendar.ics). Meetings are transcribed and [published](https://github.com/solid/team/tree/main/meetings/). Additional team meetings may be created, in which case Solid Team members will be notified via calendar invitation and in the Solid Team chat. +The Solid Team holds meetings at on every second Wednesday of the month at 15:00 UTC β€” subscribe to [vCalendar](https://raw.githubusercontent.com/solid/team/main/meetings/calendar.ics). Meetings are transcribed and [published](https://github.com/solid/team/tree/main/meetings/). Additional team meetings may be created, in which case Solid Team members will be notified via calendar invitation and in the Solid Team chat. To know more about how to contribute, check [CONTRIBUTING.md](https://github.com/solid/team/tree/main/CONTRIBUTING.md). From b7d89ff01c37f793256ea30c3f06995556b57392 Mon Sep 17 00:00:00 2001 From: Arne Hassel Date: Mon, 4 Mar 2024 17:26:54 +0100 Subject: [PATCH 07/12] 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 de88149..8241446 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -60,7 +60,7 @@ The team's decision process is inspired by the [chapter on decisions in W3C Process Document](https://www.w3.org/Consortium/Process/#decisions). The team attempts to resolve issues through dialog. Individuals who disagree strongly with a decision should register -with the leader any formal objections. +any formal objections with the leader. Any substantive issues that can't be resolved through reaching consensus through technical discussions and compromise must go through a vote, and the results must be public. Decisions may be made during [meetings](./meetings) From 56a411407cb515db7d96c825a0ca8a5ee6c8d17f Mon Sep 17 00:00:00 2001 From: Arne Hassel Date: Mon, 4 Mar 2024 17:27:03 +0100 Subject: [PATCH 08/12] 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 8241446..99a290a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -149,7 +149,7 @@ repository, create a PR. 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 +* If you run into any merge issues, review this [git tutorial](https://lab.github.com/githubtraining/managing-merge-conflicts) to help you resolve merge conflicts and other issues. * You can attribute a commit to more than one author by adding one or more From d10ad8abc1471cef5b60cca52e68fd05e5ab3fe6 Mon Sep 17 00:00:00 2001 From: Arne Hassel Date: Mon, 4 Mar 2024 17:27:13 +0100 Subject: [PATCH 09/12] 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 99a290a..f487f3f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -162,4 +162,4 @@ repository, create a PR. ### Your PR is merged! -Congratulations :tada: The Solid Team and the community thanks you :sparkles: \ No newline at end of file +Congratulations :tada: The Solid Team and the community thank you :sparkles: \ No newline at end of file From 3c3c0b7d8e99ffb2705d56c095e2432d3043137d Mon Sep 17 00:00:00 2001 From: Arne Hassel Date: Mon, 4 Mar 2024 17:27:21 +0100 Subject: [PATCH 10/12] Update README.md Co-authored-by: Ted Thibodeau Jr --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3184c01..a1be552 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ The Solid Team has a (member-only) [chat](https://gitter.im/solid/team). The Solid Team holds meetings at on every second Wednesday of the month at 15:00 UTC β€” subscribe to [vCalendar](https://raw.githubusercontent.com/solid/team/main/meetings/calendar.ics). Meetings are transcribed and [published](https://github.com/solid/team/tree/main/meetings/). Additional team meetings may be created, in which case Solid Team members will be notified via calendar invitation and in the Solid Team chat. -To know more about how to contribute, check [CONTRIBUTING.md](https://github.com/solid/team/tree/main/CONTRIBUTING.md). +To learn more about how to contribute, check [CONTRIBUTING.md](https://github.com/solid/team/tree/main/CONTRIBUTING.md). ## Membership From 6adf495dd45681e4a830781f0f3ef7114f9d60e0 Mon Sep 17 00:00:00 2001 From: Arne Hassel Date: Mon, 4 Mar 2024 17:27:29 +0100 Subject: [PATCH 11/12] Update README.md Co-authored-by: Ted Thibodeau Jr --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a1be552..834614f 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,8 @@ The Solid Team follows the [Solid Community Code of Conduct](https://github.com/ ## Tasks -The Solid Team engages in a number of tasks. A blocked task is a task that the team wants to do, but currently doesn't have the resources to do. +The Solid Team engages in a number of tasks. A blocked task is a task that the team +wants to do, but doesn't currently have sufficient resources to handle. ### Ongoing Task Forces From a294fd46dc824b9d03d1b34438199bf3df11abb4 Mon Sep 17 00:00:00 2001 From: Arne Hassel Date: Mon, 4 Mar 2024 17:27:37 +0100 Subject: [PATCH 12/12] Update README.md Co-authored-by: Ted Thibodeau Jr --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 834614f..5b3abd4 100644 --- a/README.md +++ b/README.md @@ -52,9 +52,9 @@ wants to do, but doesn't currently have sufficient resources to handle. ## Collaborations -The team collaborates with a lot of other Solid groups, such as: +The team collaborates with a lot of other Solid groups, including the following: * [Solid Community Group](https://www.w3.org/groups/cg/solid/) -* Solid Work Group +* Solid Work Groups * [Solid Creators](https://github.com/solid/process/blob/main/creators.md) * [Code of Conduct Committee](https://github.com/solid/process/blob/main/code-of-conduct.md)