~aleteoryx/muditaos

4429b4107c1061cf6da190649b850f32607fef36 — Wojtek Cichoń 5 years ago 6824ae1
[EGD-4094] Fixing all typos and missing links with one PR (#1019)

One PR - many typos and links fixed.
5 files changed, 17 insertions(+), 16 deletions(-)

M CONTRIBUTING.md
M MuditaOS-screens.png -rw-r--r-- => -rwxr-xr-x
M README.md
M doc/README.md
M doc/development_workflow.md
M CONTRIBUTING.md => CONTRIBUTING.md +6 -6
@@ 1,14 1,14 @@
# Contributing to MuditaOS

MuditaOS is an open source project and we're more than happy to receive contributions from our community. There are many ways in which you can contribute to the project from reporting bugs, suggesting features to writing code and documentation.
MuditaOS is an Open Source project and we're more than happy to receive contributions from our community. There are many ways in which you can contribute to the project from reporting bugs, suggesting features to writing code and documentation.

Before contributing please read and accept our [Code of Conduct](./CODE_OF_CODUCT.md).
Before contributing please read and accept our [Code of Conduct](./CODE_OF_CONDUCT.md).

## Reporting bugs

If you think you found a bug or a security issue in MuditaOS, we'd love to hear from you. Before you create a relevant GitHub issue please:

- make sure you're using the latest MuditaOS release when spotting the bug by heading to the `Settings` -> `Information` section on your Phone or emulator. Here you can see the all the details about the version of MuditaOS you're currently using. Please compare it with the latest stable release of MuditaOS which is always available at the top of our [changelog](./changelog.md).
- make sure you're using the latest MuditaOS release when spotting the bug by heading to the `Settings` -> `Information` section on your Phone or emulator. Here you can see the all the details about the version of MuditaOS you're currently using. Please compare it with the latest stable release of MuditaOS which is always available at the top of our [changelog](./changelog.md) and in [Releases section on GitHub](https://github.com/mudita/MuditaOS/releases).

- make sure that the issue hasn't been already reported on GitHub issues (if it has, please add a 👍 reaction to it).



@@ 25,14 25,14 @@ Feel free to add any screenshots or gifs/screencasts to illustrate the issue.

## Feature requests

If you have an idea for a feature that could possibly land in MuditaOS please let us know by simply creating an issue on Github in which you **describe the feature**, **why it would be useful** and **how it should work**. Before you create a Feature request on GitHub please:
If you have an idea for a feature that could possibly land in MuditaOS please let us know by simply creating an issue on GitHub in which you **describe the feature**, **why it would be useful** and **how it should work**. Before you create a Feature request on GitHub please:

- make sure that the feature request hasn't been already reported on GitHub issues (if it has, please add a 👍 reaction to it).

## Contributing code and documentation changes

If you would like to contribute a new feature or a bug fix to MuditaOS, please discuss your idea first in Github issues. If there is no Github issue for your idea, please open one. It may be that somebody from Mudita core team is already working on it, or that there are particular complexities that you should know about before starting the implementation.
If you would like to contribute a new feature or a bug fix to MuditaOS, please discuss your idea first in GitHub issues. If there is no Github issue for your idea, please open one. It may be that somebody from Mudita core team is already working on it, or that there are particular complexities that you should know about before starting the implementation.

Please refer to the [Development workflow article](#./doc/development_workflow.md) to learn how to submit code and documentation changes to the MuditaOS repository.
Please refer to the ["Development workflow" article](./doc/development_workflow.md) to learn how to submit code and documentation changes to the MuditaOS repository.

If you want to start localizing MuditaOS interface please start from [the "Internationalization" article](./doc/i18n.md).

M MuditaOS-screens.png => MuditaOS-screens.png +0 -0
M README.md => README.md +3 -2
@@ 19,6 19,7 @@ MuditaOS is a mobile operating system optimized for E Ink displays. Built on Fre
- contacts and calendar synchronization via Mudita Center desktop app 
- flashlight
- user interface optimized for E Ink displays with frontlight support
- dark mode
- Bluetooth headset connectivity with A2DP (Advanced Audio Distribution Profile) and HSP (Headset Profile) support
- Passive Dual SIM support
- USB-C Fast Charging


@@ 56,7 57,7 @@ You can quickstart the project by going through one of the following guides:

## Contributing

Pull requests are welcome. Please follow the guidelines in the ["Contributing to MuditaOS"](./CONTRIBUTING.md) article. Before contributing or starting a discussion, please make sure that you read our [Code of Conduct](./CODE_OF_CODUCT.md).
Pull requests are welcome. Please follow the guidelines in the ["Contributing to MuditaOS"](./CONTRIBUTING.md) article. Before contributing or starting a discussion, please make sure that you read our [Code of Conduct](./CODE_OF_CONDUCT.md).

### Discussions



@@ 103,4 104,4 @@ firefox build-<target>-<build_type>/doc/html/index.html
The [MuditaOS changelog](./changelog.md) is regularly updated by the core development team.

## License
MuditaOS is licensed on [GPL3](https://choosealicense.com/licenses/gpl-3.0/).
MuditaOS is licensed on [GNU GPLv3](https://choosealicense.com/licenses/gpl-3.0/).

M doc/README.md => doc/README.md +5 -5
@@ 34,15 34,15 @@ firefox build/doc/html/index.html
    - [Preparing packages](quickstart.md#preparing-packages)
- [Setting up integrated development environment](setup_ide.md)
- [Running MuditaOS on a phone](running_on_phone.md)
- [GUI](./module-gui/README.md)
- [GUI](../module-gui/README.md)
- [Keybindings on Linux](host_keyboard_bindings.md)
- [Development workflow](development_workflow.md)
    - [Creating release](release.md)
- [Contributing](./CONTRIBUTING.md)
- [Contributing](../CONTRIBUTING.md)
- Modules
    - [Bluetooth](./module-bluetooth/README.md)
    - [lwip](./module-lwip/README.md)
    - [Bluetooth](../module-bluetooth/README.md)
    - [lwip](../module-lwip/README.md)
- [SMS and Contacts database](database_v2.md)
- Changelog
    - [HOWTO](changelog_howto.md)
    - [Latest changelog](./changelog.md)
\ No newline at end of file
    - [Latest changelog](../changelog.md)
\ No newline at end of file

M doc/development_workflow.md => doc/development_workflow.md +3 -3
@@ 4,7 4,7 @@ When submitting code or documentation changes please follow these steps to have 

## Create a new branch

Create a branch, which name is connected to the feature, bug fix, or documentation change you want to contribute e.g. `feature/some-feature` or ``fix/some-fix`.
Create a branch, which name is connected to the feature, bug fix, or documentation change you want to contribute e.g. `feature/some-feature` or `fix/some-fix`.

**Note:** If you're part of the MuditaOS core development team, please precede the branch name with a relevant Jira ticket number e.g. `EGD-5555-some-feature`.



@@ 27,9 27,9 @@ Here's [a helpful article about writing good Git commit messages](https://chris.
Before submitting a Pull Request please go through some basic checks:

- test your changes on both Linux and RT1051 platforms (please pay special attention to the things you might break unintentionally, e.g. when working on calling funcionality, check call log too)
- [include changelog description](./doc/changelog_howto.md) (if applicable),
- [include changelog description](changelog_howto.md) (if applicable),
- run unit tests (`make check`),
- check if your code formatting complies with [`.clang-format`](./.clang-format).
- check if your code formatting complies with [`.clang-format`](../clang-format).

## Submit a Pull Request