From 6852c9d0e26a987c487898da1b20ab4921aad131 Mon Sep 17 00:00:00 2001 From: Ian Varley Date: Tue, 21 Apr 2020 16:49:43 -0500 Subject: [PATCH] A few small doc tweaks & grammar fixes (#616) * A few small documentation tweaks to fix grammar mistakes and make things more readable * Additional edit suggested in PR Co-authored-by: Ian Varley --- CONTRIBUTING.md | 18 ++++++------------ README.md | 6 +++--- 2 files changed, 9 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index decbe99a4f..3b0205b308 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -127,7 +127,7 @@ git rebase develop git push -f ``` -- Documentation on [create a Pull Request (PR) on Github](https://help.github.com/articles/using-pull-requests/) for review and merging. +- Documentation on how to [create a Pull Request (PR) on Github](https://help.github.com/articles/using-pull-requests/) for review and merging. **Note**: Even if you have write access, do not work directly on `master` or push directly to `develop`! All work is done against `develop` reviewed and merged via PRs, and ultimately `develop` gets merged into `master` for tagged code releases. @@ -143,13 +143,13 @@ This project utilizes the [Jest](https://jestjs.io/) testing framework to test t ### Adding new components/tests -When adding new components to the project, make sure to add at least snapshot test. The test files are located in the `__tests__` directory at the same level as the component you are testing. For instance, if you are adding a new view called `TestView` under the `views` directory, you would add a `TestView.spec.js` file in the `views/__tests__` directory. +When adding new components to the project, make sure to add at least a snapshot test. The test files are located in the `__tests__` directory at the same level as the component you are testing. For instance, if you are adding a new view called `TestView` under the `views` directory, you would add a `TestView.spec.js` file in the `views/__tests__` directory. -After making your changes and adding a new test file, make sure to run `yarn test` to make sure you don't have any test failures. +After making your changes and adding a new test file, run `yarn test` to make sure you don't have any test failures. ### Snapshot failures -The most common failure you will most likely run into is a snapshot failure. [Snapshot testing](https://jestjs.io/docs/en/snapshot-testing) ensures that a component renders the same output after it has been modified. If you receive a snapshot failure, check the differences in the snapshot failure to make sure they are expected changes. If they are all expected changes then you just need to update the snapshot by running `yarn test -u`. This will update the snapshot file so you can commit the changes. +The most common failure you will run into is a snapshot failure. [Snapshot testing](https://jestjs.io/docs/en/snapshot-testing) ensures that a component renders the same output after it has been modified. If you receive a snapshot failure, check the differences in the snapshot failure to make sure they are expected changes. If they are all expected changes then you just need to update the snapshot by running `yarn test -u`. This will update the snapshot file so you can commit the changes. ### Mocking modules @@ -167,15 +167,9 @@ When writing tests for components that use installed packages, we usually don't _Advanced users may install the `hub` gem and use the [`hub pull-request` command](https://github.com/defunkt/hub#git-pull-request)._ -- If not done in commit messages (which you really should do), reference and +- If not done in commit messages (which you really should do), reference and update your issue with the code changes. But _please do not close the issue yourself_. -update your issue with the code changes. But \_please do not close the issue - -yourself\_. - -- A team member will review the pull request, request change or approve and - -merge into the `develop` branch. +- A team member will review the pull request, request change or approve and merge into the `develop` branch. ## Reviewing Pull Requests diff --git a/README.md b/README.md index 2614f53bc7..9695c39f35 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ We’re building the next generation of secure location logging to preserve priv Location logs provide time-stamped records of where users have been, allowing them to share information with health officials accurately and quickly. This helps support contact tracing efforts to slow the spread of the virus. -What’s truly special about Safe Paths, though, is its privacy protection. Data never leaves user's device without their password entry and explicit consent. The location log generated by Safe Paths cannot be accessed from outside the user’s device, meaning data transfer occurs only if the user chooses to share it with the researcher. +What’s truly special about Safe Paths, though, is its privacy protection. Data never leaves a user's device without their password entry and explicit consent. The location log generated by Safe Paths cannot be accessed from outside the user’s device, meaning data transfer occurs only if the user chooses to share it with a researcher or health official. ---- @@ -16,7 +16,7 @@ What’s truly special about Safe Paths, though, is its privacy protection. Data Safe Paths is a ‘privacy-first’ app that allows you to log your GPS trails on your own phone. The information is stored locally and never shared with anyone (not even with us or MIT) until you explicitly decide to manually export the data. The location log generated by Safe Paths cannot be accessed from outside the user’s device. Location information can be imported and exported by the user and used in other projects and applications. -Safe Paths logs your device’s location once every five minutes and stores 28 days of data in under 100KB of space – less space than a single picture. But what is truly exciting about Safe Paths is its privacy protection. +Safe Paths logs your device’s location once every five minutes and stores 28 days of data in under 100KB of space. **Home page:** https://covidsafepaths.org and https://safepaths.mit.edu @@ -32,7 +32,7 @@ This is a React Native app version 61.5 ## Architecture -Please refer to `docs/Private Kit Diagram.png` for a basic overview on the sequencing of generalized events and services that are utilized by Safe Paths. +Please refer to `docs/Private Kit Diagram.png` for a basic overview on the sequencing of generalized events and services that are used by Safe Paths. ## Developer Setup