-
Notifications
You must be signed in to change notification settings - Fork 70
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* deprecated contribute files * updated content for the top menu entries
- Loading branch information
1 parent
a2773ef
commit eead8d1
Showing
7 changed files
with
92 additions
and
14 deletions.
There are no files selected for viewing
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
title: Communication | ||
order: 50 | ||
--- | ||
|
||
## Mailing list | ||
|
||
By becoming a member you will be added to the mailing list, which does not have much traffic (approximately 2-3 emails per week). You will receive the latest updates and meeting invites etc. You will also receive "final call" e-mails. These are announcements of changes (new rules, correction to existing ones, etc.) that have been approved by other members, and will be published if there is no unresolved feedback. | ||
|
||
## Slack | ||
|
||
The ACT-Rules community is active in the #act-rules channel on the W3C Community Slack. To join, you will need to [sign up for the W3C community Slack](https://w3ccommunity.slack.com/join/shared_invite/zt-drq1eer6-MlZgOJOWVAEV1UTp66ywAQ#/). Once you have signed up, you can join by visiting [w3ccommunity.slack.com](https://w3ccommunity.slack.com/). | ||
|
||
## Meetings | ||
|
||
The Community Group has conference calls twice a month. Usually, the first call is on the **second Thursday of the month** from [16:00 to 17:00 Central European Time](https://www.timeanddate.com/worldclock/fixedtime.html?msg=ACT-R+call&iso=20200813T16&p1=16&ah=1&am=00), and the second monthly call is on every **fourth Thursday of the month** from [10:00 to 11:00 Central European Time](https://www.timeanddate.com/worldclock/fixedtime.html?msg=ACT-R+call&iso=20200827T10&p1=16&ah=1&am=00). | ||
|
||
Participating in our conference calls is the easiest way to become an active contributor, get to know the other members of the Community Group, and learn from the shared pool of knowledge held by the accessibility experts in the group. | ||
|
||
The invitation and agenda for these meetings is sent out through the mailing list a few days in advance. The dates for the next 5 meetings can also be found on the agenda. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,64 @@ | ||
--- | ||
title: How to Contribute | ||
title: Contributing | ||
order: 20 | ||
--- | ||
|
||
ACT-Rules Community is a [W3C](https://www.w3.org/) [Community Group](https://www.w3.org/community/) open to anyone interested in accessibility testing, manually or automated. We welcome contributions from everyone, and there are many ways to contribute, from GitHub issues and pull requests, to contribution to our teleconferences. | ||
## Feedback on rules | ||
|
||
You don't have to be a member of the Community Group to contribute. | ||
### Discussing ideas | ||
|
||
If you want to get even more out of your involvement in our rule creation project, you can officially join the ACT-Rules Community to get on the mailing list and participate in monthly teleconferences. | ||
Rule ideas and definitions (shared terms across rules) that are currently GitHub issues can be anything from just a title to an almost finished rule draft. These Issues will be prefixed with either "Rule:" or possibly "New Rule:". | ||
|
||
<a class="btn" href="#join-the-community-group"> | ||
Learn more about how to join ACT-Rules Community | ||
</a> | ||
The top comment on such an issue should hold the most up to date version of the rule idea or algorithm, and underneath there will be a thread of related comments and a history of actions. | ||
|
||
## Overview of how you can contribute | ||
Please feel free to add your own comments to these issues. | ||
|
||
- [Give feedback on rules](/pages/contribute/rule-feedback/) | ||
- [Suggest new rules](/pages/contribute/propose-rules/) | ||
- [Join the Community Group](/pages/contribute/join/) | ||
To start giving such feedback: | ||
|
||
- See the [ideas and early drafts that might need input](https://github.com/act-rules/act-rules.github.io/issues) | ||
|
||
- Use the [Definition of "Done"](../design/definition-of-done) to guide your review | ||
|
||
### Reviewing proposals | ||
|
||
Pull requests are rule drafts that are ready for peer review. You can add yourself as a reviewer and follow the rule through iterations. A rule needs three approvals, and if a rule has the label "Reviewer wanted", we need more people to review it. However, even if three people are already reviewing it, we can always use more perspectives on things. | ||
|
||
You can add single comments to a pull request and/or do a full review. | ||
|
||
**Only approve a rule** if you feel confident (to the best of your knowledge) that this rule is 100% ready to be a published ACT rule. Please also refer to the [Definition of "Done"](../design/definition-of-done). | ||
|
||
If you for some reason are not so confident, you can always leave a comment for the things that you have an opinion about, without doing a full review. | ||
|
||
To start giving feedback and doing reviews for draft rules: | ||
|
||
- See the [draft rules and other issues that need reviews](https://github.com/act-rules/act-rules.github.io/pulls?q=is%3Aopen+is%3Apr+label%3A%22reviewers+wanted%22) | ||
- Use the [Definition of "Done"](../design/definition-of-done) to guide your review | ||
|
||
### Correcting published rules | ||
|
||
We also welcome any feedback and suggestions for changes to already published rules. The published rules should be as precise as possible, limiting the number of potential false positives and false negatives. For this, it is important to draw on as many tool and methodology implementations and expert opinions as possible. | ||
|
||
Feedback and corrections for existing rules can target any of the sections of the rule itself (Applicability, Expectations, Accessibility Support, etc.), as well as the test cases, for example to expand the edge case coverage. | ||
|
||
You have several options for correcting existing rules: | ||
|
||
- **Open a discussion in an Issue:** If you want to open a discussion, you can [open a new issue on the GitHub repository](https://github.com/act-rules/act-rules.github.io/issues) to discuss the issue with the existing rule. | ||
- **Make the change yourself in a pull request:** If you know exactly what you want changed, you can do the change yourself as a [pull request on GitHub](https://github.com/act-rules/act-rules.github.io/pulls) and submit it for review. | ||
|
||
## Rule proposals | ||
|
||
### Suggesting an idea | ||
|
||
For rule contributors with less GitHub experience, it is often easiest to start the rule design in a [GitHub issue](https://github.com/act-rules/act-rules.github.io/issues). This allows for easy editing and discussions with others, while the rule is taking shape. | ||
|
||
### Submitting a draft | ||
|
||
If you have a ready rule draft, you can submit it as a [pull request](https://github.com/act-rules/act-rules.github.io/pulls) to go into the [review process](/pages/design/process/). Be sure to use the [rule template](https://act-rules.github.io/pages/design/rule-template/) when submitting new rules. | ||
|
||
Before contributing a new rule, we recommend you check its validity with several experienced accessibility auditors first. This helps you identify potential stumbling blocks early in the rule design. | ||
|
||
## Using GitHub | ||
|
||
GitHub has excellent documentation. If you are new to GitHub, please see their documentation on how to [sign up](https://help.github.com/en/github/getting-started-with-github/signing-up-for-github), [navigate](https://help.github.com/en/github/managing-files-in-a-repository/navigating-code-on-github), [edit files](https://help.github.com/en/github/managing-files-in-a-repository/editing-files-in-another-users-repository) and [review pull requests](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/reviewing-changes-in-pull-requests). In addition to official GitHub documentation, there are a lot of excellent articles and videos on how to use GitHub. | ||
|
||
For details, see the [GitHub Guidelines for ACT-Rules](https://github.com/act-rules/act-rules.github.io/blob/develop/github-guidelines.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
title: Joining | ||
order: 30 | ||
--- | ||
|
||
1. To join ACT-Rules Community, you need a W3C Account. If you don’t already have one, [get a W3C account here](https://www.w3.org/accounts/request). | ||
2. Go to [Join the community group now!](https://www.w3.org/community/wp-login.php?redirect_to=%2Fcommunity%2Fact-r%2Fjoin) and join the group. | ||
3. If you work for a W3C Member organization, you will need to request approval. This request will be sent to your organization’s representative in the W3C’s Advisory Committee. | ||
|
||
<a class="btn" href="https://www.w3.org/community/wp-login.php?redirect_to=%2Fcommunity%2Fact-r%2Fjoin"> | ||
Join the Community Group | ||
</a> |