summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/code/Apps.md2
-rw-r--r--doc/contribute.md21
-rw-r--r--doc/gettingStarted/gettingStarted-1.0.md8
-rw-r--r--doc/maintainer-guide.md45
4 files changed, 65 insertions, 11 deletions
diff --git a/doc/code/Apps.md b/doc/code/Apps.md
index ad0f0403..cb7cd518 100644
--- a/doc/code/Apps.md
+++ b/doc/code/Apps.md
@@ -95,7 +95,7 @@ in the compilation by adding it to [CMakeLists.txt](/CMakeLists.txt).
The next step to making it launchable is to give your app an id.
To do this, add an entry in the enum class `Pinetime::Applications::Apps` ([displayapp/Apps.h](/src/displayapp/Apps.h)).
Name this entry after your app. Add `#include "displayapp/screens/MyApp.h"` to the file [displayapp/DisplayApp.cpp](/src/displayapp/DisplayApp.cpp).
-Now, go to the function `DisplayApp::LoadApp` and add another case to the switch statement.
+Now, go to the function `DisplayApp::LoadScreen` and add another case to the switch statement.
The case will be the id you gave your app earlier.
If your app needs any additional arguments, this is the place to pass them.
diff --git a/doc/contribute.md b/doc/contribute.md
index f4e241a1..29d20916 100644
--- a/doc/contribute.md
+++ b/doc/contribute.md
@@ -1,11 +1,20 @@
# How to contribute?
-- [Report bugs](https://github.com/InfiniTimeOrg/InfiniTime/issues/new?assignees=&labels=bug&template=bug-report.yaml)
-- Write and improve documentation
- - Documentation might be incomplete, or not clear enough, and it is always possible to improve it with better wording, pictures, videos,...
- - As the documentation is part of the source code, you can submit changes to the documentation by creating a pull request (see below)
-- Fix bugs, add functionalities and improve the code
- - See *How to create a pull request* below
+Here are things you can do to help.
+
+- [Report bugs or issues](https://github.com/InfiniTimeOrg/InfiniTime/issues/new/choose)
+- [Write and improve documentation](#documentation)
+- [Fix bugs, add functionalities and improve the code](#how-to-create-a-pull-request)
+- Participate in the discussions within issues and PRs. Your feedback is appreciated!
+- Review pull requests. Follow the instructions [here](maintainer-guide.md#reviewing-prs)
+
+## Documentation
+
+Documentation might be incomplete,
+or not clear enough,
+and it is always possible to improve it with better wording, pictures, videos,...
+As the documentation is part of the source code,
+you can submit changes to the documentation by creating a [pull request](#how-to-create-a-pull-request)
## How to create a pull request?
diff --git a/doc/gettingStarted/gettingStarted-1.0.md b/doc/gettingStarted/gettingStarted-1.0.md
index 989629df..5c607444 100644
--- a/doc/gettingStarted/gettingStarted-1.0.md
+++ b/doc/gettingStarted/gettingStarted-1.0.md
@@ -1,6 +1,6 @@
# Getting started with InfiniTime
-On April 22 2021, InfiniTime and Pine64 [announced the release of InfiniTime 1.0.0](https://www.pine64.org/2021/04/22/its-time-infinitime-1-0/) and the availability of PineTime smartwatches as an *enthusiast grade end-user product*. This page aims to guide you with your first step with your new PineTime.
+On April 22, 2021, InfiniTime and Pine64 [announced the release of InfiniTime 1.0.0](https://www.pine64.org/2021/04/22/its-time-infinitime-1-0/) and the availability of PineTime smartwatches as an *enthusiast grade end-user product*. This page aims to guide you with your first step with your new PineTime.
It is highly recommended to update the firmware to the latest version when you receive your watch and when a new InfiniTime version is released. More information on updating the firmware [here](/doc/gettingStarted/updating-software.md).
@@ -28,15 +28,15 @@ This is what the default digital watch face looks like. You can change watch fac
The indicator on the top left is visible if you have unread notifications
-On the top right there are status icons
+On the top right, there are status icons
- The battery icon shows roughly how much charge is remaining
- The Bluetooth icon is visible when the watch is connected to a companion app
- A plug icon is shown when the watch is plugged into a charger.
-On the bottom left you can see your heart rate if you have the measurement enabled in the heart rate app.
+On the bottom left, you can see your heart rate if you have the measurement enabled in the heart rate app.
-On the bottom right you can see how many steps you have taken today.
+On the bottom right, you can see how many steps you have taken today.
### Navigation in the menu
diff --git a/doc/maintainer-guide.md b/doc/maintainer-guide.md
new file mode 100644
index 00000000..ba95eb83
--- /dev/null
+++ b/doc/maintainer-guide.md
@@ -0,0 +1,45 @@
+# Reviewing PRs
+
+Approving a PR means that the reviewer has deemed the PR ready to be merged.
+
+There are two steps to reviewing PRs.
+
+- Review the feature:
+
+ - Consider if the feature aligns with the [InfiniTime vision](InfiniTimeVision.md)
+ - Discuss alternative ideas or implementations
+
+- Review the code:
+
+ - Check the quality of the code and make sure it conforms to the [coding conventions](coding-convention.md)
+ - Consider the maintainability of the code
+ - Test the code with at least InfiniSim or a PineTime
+
+# Merging PRs
+
+Two approvals from core developers is usually required to merge a PR.
+Exceptions include urgent fixes
+and small maintenance PRs by core developers,
+that don't affect the apparent behaviour of the watch in any way.
+
+All but the simulator check must be passed before merging a PR.
+
+PRs are either rebase or squash merged,
+depending on whether the commits satisfy the following requirements:
+
+### Commits
+
+- Commits that fix mistakes from previous commits must be squashed before merging a PR.
+- The title and description of the commit must sufficiently explain the changes in the commit.
+
+If these requirements are not met,
+the PR must be squash merged,
+and the merger must write a satisfactory description.
+
+# Stale PRs
+
+Work-in-Progress PRs shall be marked as draft.
+
+Draft PRs with no activity by the author for 3 months may be closed as stale.
+
+PRs with changes requested, but no activity by the author for 3 months may be closed as stale.