From ef7297365531261e2a64ea3c763aecebc95b4325 Mon Sep 17 00:00:00 2001 From: jowi Date: Sat, 1 Oct 2016 21:00:43 +0200 Subject: [PATCH 1/2] add CONTRIBUTING.md --- CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000000..9592d6ea1071 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,11 @@ +# Contributing to HTTPS Everywhere + +If you want to create new rules to submit to us, we expect them to be in the src/chrome/content/rules directory. That directory also contains a useful script, make-trivial-rule, to create a simple rule for a specified domain. There is also a script called trivial-validate.py, to check all the pending rules for several common errors and oversights. For example, if you wanted to make a rule for the example.com domain, you could run: +``` +cd src/chrome/content/rules +bash ./make-trivial-rule example.com +``` +This would create Example.com.xml, which you could then take a look at and edit based on your knowledge of any specific URLs at example.com that do or don't work in HTTPS. Please have a look at our [Ruleset Style Guide](https://github.com/EFForg/https-everywhere/blob/master/ruleset-style.md) where you can find useful tips about finding more subdomains. Our goal is to have as many subdomains covered as we can find. + +A more detailed guide about the syntax can be found at [EFF.org](https://www.eff.org/https-everywhere/rulesets). +For questions see our [FAQ](https://www.eff.org/https-everywhere/faq) page. From 4b4ad3defa9fad4207103013d8702a95e172eac1 Mon Sep 17 00:00:00 2001 From: jowi Date: Sat, 22 Oct 2016 12:18:41 +0200 Subject: [PATCH 2/2] formating text, change title --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9592d6ea1071..bf4b94cd25a5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,11 @@ -# Contributing to HTTPS Everywhere +# Contributing rulesets to HTTPS Everywhere -If you want to create new rules to submit to us, we expect them to be in the src/chrome/content/rules directory. That directory also contains a useful script, make-trivial-rule, to create a simple rule for a specified domain. There is also a script called trivial-validate.py, to check all the pending rules for several common errors and oversights. For example, if you wanted to make a rule for the example.com domain, you could run: +If you want to create new rules to submit to us, we expect them to be in the `src/chrome/content/rules` directory. That directory also contains a useful script, `make-trivial-rule`, to create a simple rule for a specified domain. There is also a script called `utils/trivial-validate.py`, to check all the pending rules for several common errors and oversights. For example, if you wanted to make a rule for the `example.com` domain, you could run: ``` cd src/chrome/content/rules bash ./make-trivial-rule example.com ``` -This would create Example.com.xml, which you could then take a look at and edit based on your knowledge of any specific URLs at example.com that do or don't work in HTTPS. Please have a look at our [Ruleset Style Guide](https://github.com/EFForg/https-everywhere/blob/master/ruleset-style.md) where you can find useful tips about finding more subdomains. Our goal is to have as many subdomains covered as we can find. +This would create `Example.com.xml`, which you could then take a look at and edit based on your knowledge of any specific URLs at `example.com` that do or don't work in HTTPS. Please have a look at our [Ruleset Style Guide](https://github.com/EFForg/https-everywhere/blob/master/ruleset-style.md) where you can find useful tips about finding more subdomains. Our goal is to have as many subdomains covered as we can find. A more detailed guide about the syntax can be found at [EFF.org](https://www.eff.org/https-everywhere/rulesets). For questions see our [FAQ](https://www.eff.org/https-everywhere/faq) page.