For Indeed Open Source Contributors

[zoracon]

Instructions for Indeed Open Source volunteers

Skills needed: minimal knowledge of the command line, a code editor, Git, and Github

Installation

• Please install requirements needed for HTTPS-Everywhere: https://github.com/EFForg/https-everywhere#https-everywhere-

Join chat

• https://opensource.eff.org/signup_user_complete/?id=6iqur37ucfrctfswrs14iscobw
• Once you have joined the chat, please ping me at @zoracon and I will add you to the Indeed channel

Focus: Amending rulesets

• Helping us rewrite rulesets that are redirecting to s3 bucket cdn (major Amazon service) links
• Ruleset standards:
  https://github.com/EFForg/https-everywhere/blob/master/CONTRIBUTING.md#contributing-rulesets

Issue: #17912

• Please take the time to focus on one ruleset at a time. Some rulesets are older and need more than just s3 bucket pruning. Some may need more test urls or host updates. We have tests that run on each PR submission, but there are ways to locally test if your environment set up.
  -- Within the repo, you can test a ruleset file with this command:
  python3.6 test/rules/src/https_everywhere_checker/check_rules.py test/rules/http.checker.config rules/example-file.xml.
  -- This command will run checks against each host and for proper test coverage. Please address error that may appear.

Example of helpful commit: 7b8f315

[zoracon]

Example workflow

1. Run test initially to see which hosts currently have issues
   python3.6 test/rules/src/https_everywhere_checker/check_rules.py test/rules/http.checker.config rules/example-file.xml

• Some hosts have issues? Take out and leave a comment about the error the hosts gave
• The main host can't be resolved? The ruleset can be removed entirely, commit and push PR.

2. Remove any references to s3 buckets.

3. Update possible missed subdomains with Sublistr tool or dnsdumpster.com.

4. Run check_rules.py test again to see if any hosts or coverage is needed still.

5. Repeat test until ruleset checks out and push a PR to the forked repo comparing to the master branch of the EFF/Https-Everywhere repo.

• PR should reference HTTP nowhere mode hijacks legit Firefox warning pages. #17192
• PR should be labeled "amazon-s3-2020"

[zoracon]

Closing for now since this event has passed.