Bug 1466717 [wpt PR 11335] - Mention the lint tool in the github tutorial, a=testonly
authorFlorian Rivoal <git@florian.rivoal.net>
Fri, 06 Jul 2018 13:55:13 +0000
changeset 425824 1b677f686d7d874f7329b39ef866d009cc81b6a7
parent 425823 a395b17a56c54aa7a52e77bef61425d38936af05
child 425825 986d9d5e1ea3a0f14c26e4007f659befba5278e6
push id34267
push userrgurzau@mozilla.com
push dateWed, 11 Jul 2018 22:05:21 +0000
treeherdermozilla-central@3aca103e4915 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewerstestonly
bugs1466717, 11335
milestone63.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1466717 [wpt PR 11335] - Mention the lint tool in the github tutorial, a=testonly Automatic update from web-platform-testsMerge pull request #11335 from frivoal/git-doc-lint Mention the lint tool in the github tutorial -- wpt-commits: ed8650a5dbbaacd706dd99e24b0cacaadaef74e2 wpt-pr: 11335
testing/web-platform/meta/MANIFEST.json
testing/web-platform/tests/docs/_appendix/github-intro.md
--- a/testing/web-platform/meta/MANIFEST.json
+++ b/testing/web-platform/meta/MANIFEST.json
@@ -561791,17 +561791,17 @@
    "aeebae31cec9dcf7a29f11858f6e67e03366e876",
    "support"
   ],
   "docs/OWNERS": [
    "8b8fcd1bcd07619951c92029a3f5cad01fa75d44",
    "support"
   ],
   "docs/_appendix/github-intro.md": [
-   "c26effebf90d5483a890945f191b2f3626301962",
+   "3f09e8df280098fd0ba4db11bba34517e32b0654",
    "support"
   ],
   "docs/_appendix/index.md": [
    "eb9d13a352bcecf35ce0e78f593eecac33f858cd",
    "support"
   ],
   "docs/_appendix/test-templates.md": [
    "7dd354e2935ae85d867a069eac4a1ca4225d4140",
--- a/testing/web-platform/tests/docs/_appendix/github-intro.md
+++ b/testing/web-platform/tests/docs/_appendix/github-intro.md
@@ -173,16 +173,36 @@ 5.  Alternatively, you can run `git diff
 
 6.  Once you've added everything, you can commit and add a message to this
     set of changes:
 
         $ git commit -m "Tests for indexed getters in the HTMLExampleInterface"
 
 7.  Repeat these steps as many times as you'd like before you submit.
 
+## Verify
+
+The Web Platform Test project has an automated tool
+to verify that coding conventions have been followed,
+and to catch a number of common mistakes.
+
+You can and should run this tool locally.
+It will be run on your submissions anyway,
+and any failure will be grounds for rejection,
+so you might as well fix them first.
+
+1. On the command line, navigate to to the directory where your clone
+of the repository is located.
+
+2. Run `./wpt lint`
+
+3. Fix any mistake it reports and [commit](#commit) again.
+
+For more details, see the [documentation about the lint tool][lint-tool]
+
 ## Submit
 
 If you're here now looking for more instructions, that means you've written
 some awesome tests and are ready to submit them. Congratulations and welcome
 back!
 
 1.  The first thing you do before submitting them to the W3C repo is to push
 them back up to the server:
@@ -394,8 +414,9 @@ you may also discard your connection to 
 [remote-upstream]: #configure-remote-upstream
 [cleanup]: #cleanup
 [pencil-icon]: {{ site.baseurl }}{% link /assets/pencil-icon.png %}
 [commitbtn]: {{ site.baseurl }}{% link /assets/commitbtn.png %}
 [commit-directly]: {{ site.baseurl }}{% link /assets/commit-directly.png %}
 [files-changed]: {{ site.baseurl }}{% link /assets/files-changed.png %}
 [more-commits]: {{ site.baseurl }}{% link /assets/more-commits.png %}
 [github flow]: https://guides.github.com/introduction/flow/
+[lint-tool]: {{ site.baseurl }}/writing-tests/lint-tool.html