Skip to content

Commit

Permalink
Updated documentation with references to example-apps and overall lan…
Browse files Browse the repository at this point in the history
…guage improvements
  • Loading branch information
simonmicro committed Jun 4, 2023
1 parent 6b1e46b commit 3cbe234
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 9 deletions.
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
# How to contribute to Open-smartwatch

In case the `develop` branch is ahead of the `master` branch and the `develop` branch is stabile enough, we periodically merge it into the `master`.
In case the `develop` branch is ahead of the `master` branch and the `develop` branch is stable enough, we periodically merge it into the `master`.

In order to contribute new or updated documentation, you must first create a GitHub account and fork the original repository to your own account. You can make changes, save them in your repository and then create a pull request against this repository.

Unless you are opening a pull request which only makes small corrections (for instance correcting a typo), you are more likely to get traction for your changes if you open an issue first to discuss the proposed changes.

**IMPORTANT** If you want to create a pull request, please work based on the `develop` branch - so we don't have to rebase it...
**IMPORTANT** If you want to create a pull request, please work based on the most recent `develop` branch - so we don't have to rebase it...

If you are reading this page, you are possibly interested in contributing to our project 😄 . We have an active (and friendly) developer group and would love to get your help! Some common ways you can support us are:

* Testing the code
* Filing issues on GitHub, if you see a problem (or adding detail to existing issues that effect you)
* Reporting issues on GitHub, if you see a problem (or adding detail to existing issues that also affect you)
* Fixing issues 😁
* Adding new features
* Reviewing existing pull requests and possibly also contributing to them.
* Translation. Always a good idea...
* Reviewing existing pull requests and possibly also contributing to them
* Translations are always a good idea...

## How to make a good bug report

Submit according to the bug report form. Attach the debug log if necessary. [Read more here!](https://open-smartwatch.github.io/howto/contribute/#how-to-open-an-issue)

## Submitting patches

Please also see our [wiki](https://open-smartwatch.github.io/howto/contribute/) article for that.
Please also see our [wiki](https://open-smartwatch.github.io/howto/contribute/) article for that.
5 changes: 4 additions & 1 deletion docs/firmware/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,10 @@ If you have cloned the repo without the recurse option, run `git submodule updat

!!! note "Tip"
After changing or updating/pulling a branch, run the command again to also update dependencies:
`git submodule update`
```bash
git pull
git submodule update --init --recursive
```

Then, open the directory with Visual Studio Code.

Expand Down
7 changes: 5 additions & 2 deletions docs/firmware/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,11 @@ Check the driver insertion.
You did not clone the repository with the `--recursive-submodules` flag.

!!! note "Tip"
After changing the branch, follow the command :
`git submodule update`
After changing or updating/pulling a branch, run the command again to also update dependencies:
```bash
git pull
git submodule update --init --recursive
```

## Failed to connect to ESP32: Timed out waiting for packet header

Expand Down

0 comments on commit 3cbe234

Please sign in to comment.