Skip to content

Latest commit

 

History

History
45 lines (35 loc) · 3.61 KB

Getting-Started.md

File metadata and controls

45 lines (35 loc) · 3.61 KB
Raw

Getting Started

Please read the Related Website Sets Submission Guidelines for full instructions and guidance on how to submit a set. This Getting Started guide will provide general guidance on navigating this repo.

Changes are made by creating a Pull Request (PR) from your branch to the main branch. When this occurs, a Github Action will trigger, visible in .github/workflows/rws-submissions-checks.yml . This action will run check_sites.py , which calls a number of submission checks visible in RwsCheck.py . Once it has run its action, you can see any errors in the "Actions" tab of the repository.

Note: All contributors to the GoogleChrome repo will need to sign a Contributor's License Agreement.

Creating your Submission

To create or revise a submission, you will first need to create a local copy of the repo. To do this, follow this GitHub guide on cloning a repository. Once you've you cloned the repo, you can create a new branch by using the call "git checkout -b your-branch-name -t origin/main". When making your changes to related_website_sets.JSON, follow the schema in the Submission Guidelines.

Testing your Submission Locally

Once you've made your changes to your local branch, you can open a terminal and run the command python3 check_sites.py. Currently, this will produce a number of check failures due to older submissions in the set failing recent changes to checks. If no members of your set are mentioned in the list of failed checks, then your submission should be fine. If you would like a cleaner way of looking for problems in your set, follow these steps:

  1. Run `cp related_website_sets.JSON my_rws.JSON` in your shell
  2. Make your changes to `my_rws.JSON` and make sure `related_website_sets.JSON` is identical to the version in main.
  3. To test your local changes, run `python3 check_sites.py -i my_rws.JSON --with_diff`
  4. When you are ready to submit, copy your changes from `my_rws.JSON` into `related_website_sets.JSON` and delete `my_rws.JSON`

Creating your Pull Request

Once you're satisfied with your changes and they are passing the checks locally, you can prepare to create a Pull Request (PR). You can push your local changes to your remote branch, and then create a PR to pull your branch into master. Once you have done this you may need to resolve any merge conflicts. When this is done, wait for the actions to finish running, which will tell you whether your PR has passed or failed the checks.

Debugging Failures

If all checks succeed, there should be a check mark. On failure, there will be a red "x." Make sure you wait for the action to finish! Sometimes, especially if you had merge conflicts that you had to squash, a checkmark will appear before the action has actually run. To be absolutely certain, always check the "Actions" tab to see the status of the run triggered by your request. The details of the failure will be visible by clicking on "PR-Actions" and then clicking the drop down labeled "File contents."