Re: [w3c/permissions] chore: update how to contribute (#281)

@miketaylr commented on this pull request.



> +- Running tidy is optional. We run tidy on the server after every commit.
+- Put comments in front of sections, for better readability with
+  syntax coloring editors.
+
+## Commit message guidelines
+
+  - When relevant, include `closes #` and the issue number.
+  - The commit message should be short and concise.
+  - Prefix the commit message with one of the following:
+    - `Editorial:` -for editorial/non-normative change to the specification.
+    - `Chore:` - when fixing ReSpec stuff or other non-spec related stuff (e.g., CI).
+    - Normative changes should not be prefixed with anything. These go into the changelog.
+
+## Running HTML5 Tidy
+
+Please make sure you have [HTML5 Tidy](https://github.com/w3c/tidy-html5) installed.

nit: that URI redirects to https://github.com/htacg/tidy-html5, not sure if it's worth updating or if you prefer living w/ the redirect

> +  - When relevant, include `closes #` and the issue number.
+  - The commit message should be short and concise.
+  - Prefix the commit message with one of the following:
+    - `Editorial:` -for editorial/non-normative change to the specification.
+    - `Chore:` - when fixing ReSpec stuff or other non-spec related stuff (e.g., CI).
+    - Normative changes should not be prefixed with anything. These go into the changelog.
+
+## Running HTML5 Tidy
+
+Please make sure you have [HTML5 Tidy](https://github.com/w3c/tidy-html5) installed.
+Don't use the the one that ships with \*nix systems.
+
+You can confirm check the version by running:
+
+```bash
+tidy --version  #HTML Tidy for HTML5 (experimental) for ...

Mine say `HTML Tidy for Apple macOS version 5.8.0`. Is there a minimum supported version folks should be aiming for?

(the "old" one reports `HTML Tidy for Mac OS X released on 31 October 2006 - Apple Inc. build 1045`

> +- Running tidy is optional. We run tidy on the server after every commit.
+- Put comments in front of sections, for better readability with
+  syntax coloring editors.
+
+## Commit message guidelines
+
+  - When relevant, include `closes #` and the issue number.
+  - The commit message should be short and concise.
+  - Prefix the commit message with one of the following:
+    - `Editorial:` -for editorial/non-normative change to the specification.
+    - `Chore:` - when fixing ReSpec stuff or other non-spec related stuff (e.g., CI).
+    - Normative changes should not be prefixed with anything. These go into the changelog.
+
+## Running HTML5 Tidy
+
+Please make sure you have [HTML5 Tidy](https://github.com/w3c/tidy-html5) installed.

Thinking with my "new contributor hat" and trying to figure out how to download and install tidy, the README in this repo isn't helpful. Building from source feels like overkill. Going to http://www.html-tidy.org/... it's a non-secure site, so I totally don't want to install the binaries there.

(edit: they _do_ have a secure version of the binaries page, at https://binaries.html-tidy.org/)

Grabbing the latest release from https://github.com/htacg/tidy-html5/releases is probably fine, or the site has links to package managers, e.g., `brew install tidy-html5` for macOS.

Perhaps we could add a sentence after `Please make sure you have [HTML5 Tidy](https://github.com/w3c/tidy-html5) installed.` like:

> Please make sure you have [HTML5 Tidy](https://github.com/w3c/tidy-html5) installed. You can download the [latest stable release from GitHub](https://github.com/htacg/tidy-html5/releases) or follow the "Get Tidy" instructions at http://www.html-tidy.org/.

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/w3c/permissions/pull/281#pullrequestreview-742647662