Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2024-10-20 16:55:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Bug 1572792 [wpt PR 18343] - [docs] Improve submission guidelines, a=testonly

Browse Source 
Automatic update from web-platform-tests
[docs] Reorganize information on test submission

Relocate README content relevant pages within the documentation site,
split apart according to the intended audience.

--
[docs] Streamline information on test submission

Recommend the detailed "Introduction to GitHub" prior to summarizing the
preferred workflow to more quickly support readers who need additional
guidance.

Shorten the summarized steps to more efficiently direct readers who are
familiar with the process.

--
[docs] Document requirement for PR approval

--
[docs] Remove conflicting use of term "upstream"

The term "upstream" is typically reserved for the canonical version of
the source code. Replace usages which contradict that meaning with a
less specific term, "trusted fork."

--
[docs] Remove duplicated content

--
[docs] Improve link text

--

wpt-commits: 18a159fb46bf3966b5bb1f589e24df10495a6d10, bbc9fe01d21d83458a4a7897a2e83b87a96fff18, a4d0ede58d7c43bc108c9c5b5cc6fc29de6dfb67, 0bd47344377f14bceb09b64448c86289e1ac0265, 44cbd35cae868b0d2948978d77af1e6324e9a407, 2ae2a10e2c4272baca94374b2ce644084e89bf98
wpt-pr: 18343
This commit is contained in:
Mike Pennisi 2019-08-14 10:56:43 +00:00 committed by moz-wptsync-bot
parent 38614c2d96
commit ebc6a0364c
4 changed files with 37 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
testing/web-platform/tests/README.md
View File

@ -269,31 +269,6 @@ For more details, see the [lint-tool documentation][lint-tool].
[lint-tool]: https://web-platform-tests.org/writing-tests/lint-tool.html
Test Review
===========
We can sometimes take a little while to go through pull requests
because we have to go through all the tests and ensure that they match
the specification correctly. But we look at all of them, and take
everything that we can.
META.yml files are used only to indicate who should be notified of pull
requests. If you are interested in receiving notifications of proposed
changes to tests in a given directory, feel free to add yourself to the
META.yml file. Anyone with expertise in the specification under test can
approve a pull request. In particular, if a test change has already
been adequately reviewed "upstream" in another repository, it can be
pushed here without any further review by supplying a link to the
upstream review.
Search filters to find things to review:
* [Open PRs (excluding vendor exports)](https://github.com/web-platform-tests/wpt/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+-label%3A%22mozilla%3Agecko-sync%22+-label%3A%22chromium-export%22+-label%3A%22webkit-export%22+-label%3A%22servo-export%22+-label%3Avendor-imports)
* [Reviewed but still open PRs (excluding vendor exports)](https://github.com/web-platform-tests/wpt/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+-label%3Amozilla%3Agecko-sync+-label%3Achromium-export+-label%3Awebkit-export+-label%3Aservo-export+-label%3Avendor-imports+review%3Aapproved+-label%3A%22do+not+merge+yet%22+-label%3A%22status%3Aneeds-spec-decision%22) (Merge? Something left to fix? Ping other reviewer?)
* [Open PRs without reviewers](https://github.com/web-platform-tests/wpt/pulls?q=is%3Apr+is%3Aopen+label%3Astatus%3Aneeds-reviewers)
* [Open PRs with label `infra` (excluding vendor exports)](https://github.com/web-platform-tests/wpt/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+label%3Ainfra+-label%3A%22mozilla%3Agecko-sync%22+-label%3A%22chromium-export%22+-label%3A%22webkit-export%22+-label%3A%22servo-export%22+-label%3Avendor-imports)
* [Open PRs with label `docs` (excluding vendor exports)](https://github.com/web-platform-tests/wpt/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+label%3Adocs+-label%3A%22mozilla%3Agecko-sync%22+-label%3A%22chromium-export%22+-label%3A%22webkit-export%22+-label%3A%22servo-export%22+-label%3Avendor-imports)
Getting Involved
================

23
testing/web-platform/tests/docs/reviewing-tests/index.md
View File

@ -38,3 +38,26 @@ working on other things as tests frequently only get pushed upstream
once the code lands in their implementation.
To assist with test reviews, a [review checklist](checklist) is available.
[GitHub.com allows reviewers to formally signal their approval of a pull
request through a dedicated user
interface.](https://help.github.com/en/articles/about-pull-request-reviews)
Every pull request submitted to WPT must be approved by at least one project
collaborator before it can be merged.
## Notifications
META.yml files are used only to indicate who should be notified of pull
requests. If you are interested in receiving notifications of proposed
changes to tests in a given directory, feel free to add yourself to the
META.yml file.
## Finding contributions to review
Here are a few search filters to find things to review:
* [Open PRs (excluding vendor exports)](https://github.com/web-platform-tests/wpt/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+-label%3A%22mozilla%3Agecko-sync%22+-label%3A%22chromium-export%22+-label%3A%22webkit-export%22+-label%3A%22servo-export%22+-label%3Avendor-imports)
* [Reviewed but still open PRs (excluding vendor exports)](https://github.com/web-platform-tests/wpt/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+-label%3Amozilla%3Agecko-sync+-label%3Achromium-export+-label%3Awebkit-export+-label%3Aservo-export+-label%3Avendor-imports+review%3Aapproved+-label%3A%22do+not+merge+yet%22+-label%3A%22status%3Aneeds-spec-decision%22) (Merge? Something left to fix? Ping other reviewer?)
* [Open PRs without reviewers](https://github.com/web-platform-tests/wpt/pulls?q=is%3Apr+is%3Aopen+label%3Astatus%3Aneeds-reviewers)
* [Open PRs with label `infra` (excluding vendor exports)](https://github.com/web-platform-tests/wpt/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+label%3Ainfra+-label%3A%22mozilla%3Agecko-sync%22+-label%3A%22chromium-export%22+-label%3A%22webkit-export%22+-label%3A%22servo-export%22+-label%3Avendor-imports)
* [Open PRs with label `docs` (excluding vendor exports)](https://github.com/web-platform-tests/wpt/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+label%3Adocs+-label%3A%22mozilla%3Agecko-sync%22+-label%3A%22chromium-export%22+-label%3A%22webkit-export%22+-label%3A%22servo-export%22+-label%3Avendor-imports)

3
testing/web-platform/tests/docs/writing-tests/github-intro.md
View File

@ -249,7 +249,8 @@ GitHub UI. Below is one method and others can be found on
4. Wait for feedback on your pull request and once your pull request is
accepted, delete your branch (see '[When Pull Request is Accepted](#cleanup)').
That's it! Your pull request will go into a queue and will be reviewed soon.
[This page on the submissions process](submission-process) has more detail
about what to expect when contributing code to WPT.
## Refine

27
testing/web-platform/tests/docs/writing-tests/submission-process.md
View File

@ -1,28 +1,24 @@
# Submitting Tests
Test submission is via the typical [GitHub workflow][github flow]:
Test submission is via the typical [GitHub workflow][github flow]. For detailed
guidelines on setup and each of these steps, please refer to the [Github Test
Submission](github-intro) documentation.
* Fork the [GitHub repository][repo] (and make sure you're still relatively in
sync with it if you forked a while ago)
* Fork the [GitHub repository][repo].
* Create a branch for your changes. Being a key of effective Git flow, it is
strongly recommended that the **topic branch** tradition be followed here,
i.e. the branch naming convention is based on the "topic" you will be working
on, e.g. `git checkout -b topic-name`
* Create a feature branch for your changes.
* Make your changes
* Make your changes.
* Run the `lint` script in the root of your checkout to detect common
mistakes in test submissions. This will also be run after submission
and any errors will prevent your PR being accepted. If it detects an
error that forms an essential part of your test, edit the list of
exceptions stored in `tools/lint/lint.whitelist`.
mistakes in test submissions. There is [detailed documentation for the lint
tool](lint-tool).
* Commit your changes.
* Push your local branch to your GitHub repository.
* Using the GitHub UI create a Pull Request for your branch.
* Using the GitHub UI, create a Pull Request for your branch.
* When you get review comments, make more commits to your branch to
address the comments.
@ -30,8 +26,9 @@ on, e.g. `git checkout -b topic-name`
* Once everything is reviewed and all issues are addressed, your pull
request will be automatically merged.
For detailed guidelines on setup and each of these steps, please refer to the
[Github Test Submission](../writing-tests/github-intro) documentation.
We can sometimes take a little while to go through pull requests because we
have to go through all the tests and ensure that they match the specification
correctly. But we look at all of them, and take everything that we can.
Hop on to the [mailing list][public-test-infra] or [IRC][]
([webclient][web irc], join channel `#testing`) if you have an issue. There is