diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ff06085..089a7a7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,10 +10,10 @@ Please note we have a [Code of Conduct](#code-of-conduct), please follow it in a ## Pull Request Process 1. Fork the repository. -2. Commit your changes to your fork. -3. Submit a pull request. -4. Handle any feedback before the request is merged. -5. Accept our sincere Thank You! +1. Commit your changes to your fork. +1. Submit a pull request. +1. Handle any feedback before the request is merged. +1. Accept our sincere Thank You! ## Code of Conduct diff --git a/README.md b/README.md index a380163..4630faf 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ The watch includes a limited subset of the features proposed in the [original mo 1. Basic home page with time and 4 readings shared from the device via the mobile app 1. Alerts if one of the readings crosses a threshold which in turn initiates a vibration -The smartphone is responsible for pairing with the watch and the sensor device. The watch receives pushed updates over Bluetooth from the smartphone every second. If any indicator has been red for 5 seconds, it vibrates the watch. +The smartphone is responsible for pairing with the watch and the device. The watch receives pushed updates over Bluetooth from the smartphone every second. If any indicator has been red for 5 seconds, it vibrates the watch. The application is built as a [Tizen Web (Companion) Application](https://developer.samsung.com/galaxy-watch-develop/creating-your-first-app/web-companion/setup-sdk.html) so it uses HTML, JavaScript, and CSS. diff --git a/contributing/ISSUES.md b/contributing/ISSUES.md index 013ba4d..f979532 100644 --- a/contributing/ISSUES.md +++ b/contributing/ISSUES.md @@ -15,10 +15,10 @@ contribute: 1. By opening the issue for discussion: For instance, if you believe that you have uncovered a bug in Pyrrha, creating a new issue in the `Pyrrha-Platform/Pyrrha-Watch-App` issue tracker is the way to report it. -2. By helping to triage the issue: This can be done either by providing +1. By helping to triage the issue: This can be done either by providing supporting details (a test case that demonstrates a bug), or providing suggestions on how to address the issue. -3. By helping to resolve the issue: Typically this is done either in the form +1. By helping to resolve the issue: Typically this is done either in the form of demonstrating that the issue reported is not a problem after all, or more often, by opening a Pull Request that changes some bit of something in `Pyrrha-Platform/Pyrrha-Watch-App` in a concrete and reviewable manner. diff --git a/contributing/PULL-REQUESTS.md b/contributing/PULL-REQUESTS.md index f9bd509..0f2025e 100644 --- a/contributing/PULL-REQUESTS.md +++ b/contributing/PULL-REQUESTS.md @@ -26,7 +26,7 @@ so that you can make the actual changes. This is where we will start. - [Respect the minimum wait time for comments](#respect-the-minimum-wait-time-for-comments) - [Abandoned or stalled pull requests](#abandoned-or-stalled-pull-requests) - [Approving a change](#approving-a-change) - - [Accept that there are different opinions about what belongs in Pyrrha](#accept-that-there-are-different-opinions-about-what-belongs-in-Pyrrha) + - [Accept that there are different opinions about what belongs in Pyrrha](#accept-that-there-are-different-opinions-about-what-belongs-in-pyrrha) - [Performance is not everything](#performance-is-not-everything) - [Continuous integration testing](#continuous-integration-testing) - [Notes](#notes) @@ -56,18 +56,18 @@ locally. You will need to have [Git Large File Storage](https://help.github.com/en/github/managing-large-files/installing-git-large-file-storage) installed locally. -```text -$ git clone git@github.com:username/Pyrrha.git -$ cd Pyrrha -$ git remote add upstream https://github.com/Pyrrha-Platform/Pyrrha-Watch-App.git -$ git fetch upstream +```sh +git clone git@github.com:username/Pyrrha.git +cd Pyrrha +git remote add upstream https://github.com/Pyrrha-Platform/Pyrrha-Watch-App.git +git fetch upstream ``` It is recommended to configure `git` so that it knows who you are: -```text -$ git config user.name "J. Random User" -$ git config user.email "j.random.user@example.com" +```sh +git config user.name "J. Random User" +git config user.email "j.random.user@example.com" ``` You can use any name/email address you prefer here. We only use the @@ -80,8 +80,8 @@ As a best practice to keep your development environment as organized as possible, create local branches to work within. These should also be created directly off of the `master` branch. -```text -$ git checkout -b my-branch -t upstream/master +```sh +git checkout -b my-branch -t upstream/master ``` ## The process of making changes @@ -97,9 +97,9 @@ as possible within individual commits. There is no limit to the number of commits any single pull request may have, and many contributors find it easier to review changes that are split across multiple commits. -```text -$ git add my/changed/files -$ git commit +```sh +git add my/changed/files +git commit ``` Note that multiple commits often get squashed when they are landed (see the @@ -161,9 +161,9 @@ As a best practice, once you have committed your changes, it is a good idea to use `git rebase` (not `git merge`) to synchronize your work with the main repository. -```text -$ git fetch upstream -$ git rebase upstream/master +```sh +git fetch upstream +git rebase upstream/master ``` This ensures that your working branch has the latest changes from @@ -179,8 +179,8 @@ Once you are sure your commits are ready to go, with passing tests and linting, begin the process of opening a pull request by pushing your working branch to your fork on GitHub. -```text -$ git push origin my-branch +```sh +git push origin my-branch ``` ### Step 8: Opening the pull request @@ -205,19 +205,19 @@ To make changes to an existing pull request, make the changes to your local branch, add a new commit with those changes, and push those to your fork. GitHub will automatically update the pull request. -```text -$ git add my/changed/files -$ git commit -$ git push origin my-branch +```sh +git add my/changed/files +git commit +git push origin my-branch ``` It is also frequently necessary to synchronize your pull request with other changes that have landed in `master` by using `git rebase`: -```text -$ git fetch --all -$ git rebase origin/master -$ git push --force-with-lease origin my-branch +```sh +git fetch --all +git rebase origin/master +git push --force-with-lease origin my-branch ``` **Important:** The `git push --force-with-lease` command is one of the few ways @@ -228,10 +228,10 @@ risks. If in doubt, you can always ask for guidance in the pull request or on th If you happen to make a mistake in any of your commits, do not worry. You can amend the last commit (for example if you want to change the commit log). -```text -$ git add any/changed/files -$ git commit --amend -$ git push --force-with-lease origin my-branch +```sh +git add any/changed/files +git commit --amend +git push --force-with-lease origin my-branch ``` There are a number of more advanced mechanisms for managing commits using @@ -295,7 +295,7 @@ does not land, the submitters should come away from the experience feeling like their effort was not wasted or unappreciated. Every pull request from a new contributor is an opportunity to grow the community. -### Review a bit at a time. +### Review a bit at a time Do not overwhelm new contributors. @@ -358,7 +358,7 @@ check with the contributor to see if they intend to continue the work before checking if they would mind if you took it over (especially if it just has nits left). When doing so, it is courteous to give the original contributor credit for the work they started (either by preserving their name and email -address in the commit log, or by using an `Author: ` meta-data tag in the +address in the commit log, or by using an `Author:` meta-data tag in the commit. ### Approving a change @@ -481,5 +481,4 @@ collaborators may decide it doesn't need to wait. A pull request may well take longer to be merged in. [code of conduct]: https://github.com/Pyrrha-Platform/Pyrrha-Watch-App/blob/master/CONTRIBUTING.md#code-of-conduct -[collaborator guide]: https://github.com/Pyrrha-Platform/Pyrrha-Watch-App/blob/master/CONTRIBUTING.md [pyrrha slack workspace]: https://callforcode.org/slack