Skip to content

Commit

Permalink
feat: expand section on contributing to the spec (#795)
Browse files Browse the repository at this point in the history
Signed-off-by: Wouter Termont <[email protected]>
Co-authored-by: Timea <[email protected]>
  • Loading branch information
woutermont and timea-solid authored Jul 25, 2023
1 parent 4dabce5 commit 087f23f
Showing 1 changed file with 43 additions and 15 deletions.
58 changes: 43 additions & 15 deletions pages/specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,36 +8,64 @@ redirect_from:

# Specification

To read the current specification, see [Solid Specification](https://solidproject.org/TR/).

## Contribute
The Solid Specification consists of several [Technical Reports](https://solidproject.org/TR/), each of which is edited by a
[Solid panel](https://github.com/solid/specification/blob/main/README.md#solid-panels).

## Contributing to the specification

<div class="message is-info">
<p class="message-body">
Before contributing, please read the
<a href="https://github.com/solid/process/blob/master/code-of-conduct.md">Code of Conduct</a>
and <a href="https://www.w3.org/community/solid/"> join the W3C Solid Community Group</a>.
<a href="https://github.com/solid/process/blob/master/code-of-conduct.md">Solid Code of Conduct</a>
and the <a href="https://www.w3.org/Consortium/cepc/"
>W3C Code of Ethics and Professional Conduct</a>.
Join the <a href="https://www.w3.org/community/solid/">W3C Solid Community Group</a>
before providing substantial contributions.
Note that Solid encourages adherence to the W3C's
<a href="https://www.w3.org/TR/design-principles/">Web Platform Design Principles</a>,
in particular the <a href="https://www.w3.org/TR/design-principles/#priority-of-constituencies">Priority of Constituencies</a>.
</p>
</div>

Anyone can contribute by filing an [issue via GitHub](https://github.com/solid/specification/issues)
or by submitting [pull requests](https://github.com/solid/specification/pulls).

For new proposals, present your proposals at the relevant meetings
and communication channels, which include the following weekly recurring meetings:
Present your proposals via the most relevant meetings
and communication channels:

- Submit new **<u>User Stories</u>** to
the [Solid User Stories](https://github.com/solid/user-stories/)
repository. They are tagged according to the aspects of Solid
that are relevant to them, so that specification panels can easily
find them for the work items at hand.

- Help formulate **<u>Use Cases and Requirements</u>** (UCR) based on the User Stories for each TR:

* [Authorization UCR](https://solid.github.io/authorization-panel/authorization-ucr/)
* [Notifications UCR](https://solid.github.io/notifications-panel/notifications-ucr.html)
* Upcoming: WebID-Profile UCR ([issue](https://github.com/solid/webid-profile/issues/55),
[PR](https://github.com/solid/webid-profile/pull/80))

| Panel | When | Meeting Link |
| ----- |------|--------------|
| [Authentication Panel](https://www.w3.org/community/solid/wiki/Authentication_Panel) | Mondays at 16:00 Central European / 10:00 Eastern | [Meeting](https://meet.jit.si/solid-authentication) |
| [Interoperability Panel](https://www.w3.org/community/solid/wiki/Interoperability_Panel) | Tuesdays at 16:00 Central European / 10:00 Eastern | [Meeting](https://meet.jit.si/solid-data-interoperability) |
| [Authorization Panel](https://www.w3.org/community/solid/wiki/Authorization_Panel) | Wednesday at 16:00 Central European / 10:00 Eastern | [Meeting](https://meet.jit.si/solid-authorization) |
All Solid UCRs are reviewed by the Diversity, Equity, and Inclusion Team
([DEIT](https://github.com/solid/deit/blob/main/meetings/2021-11-09.md#deit-to-review-use-cases-in-specification-development)).

- Join the Solid [Panel Meetings](https://github.com/solid/specification/blob/main/README.md#solid-panels)
to listen, provide insight or suggest topics for discussion.
Meeting schedules, agendas and minutes can be found on the GitHub
pages of each panel.
Please read the
[guidelines for participation](https://github.com/solid/specification/blob/main/meetings/README.md)
before calling in.


More details on how to contribute can be found [on GitHub](https://github.com/solid/specification/blob/main/CONTRIBUTING.md).
All proposals undergo an Editorial review process. For more information
on proposal submissions and reviews, see the
[Solid Process](https://github.com/solid/process#reviewing-proposals).
[Solid Process](https://github.com/solid/process).


## Track Progress
## Tracking Progress

Keep up-to-date with specification progress by signing up for
[This Month in Solid](https://solidproject.org/newsletter).
[This Month in Solid](/newsletter).
Minutes of meetings are kept by each [panel](https://github.com/solid/specification/blob/main/README.md#solid-panels) to track ongoing discussions.

0 comments on commit 087f23f

Please sign in to comment.