mpusz/mp-units
1
0
Fork 1
mirror of https://github.com/mpusz/mp-units.git synced 2025-08-04 12:54:25 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix typos in contributing.md

Browse Source
This commit is contained in:
Markus Hofbauer
2022-03-17 15:35:07 +01:00
parent cc90985958
commit c3ff6a22d2
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@@ -4,7 +4,7 @@
## Gitpod
The easiest way to start coding is to jump streight into [Gitpod](https://www.gitpod.io). You can either click the button
The easiest way to start coding is to jump straight into [Gitpod](https://www.gitpod.io). You can either click the button
below or prefix any `mp-units` URL (main branch, other branches, issues, PRs, ...) in your web browser with `gitpod.io/#`
(i.e. https://gitpod.io/#https://github.com/mpusz/units).
@@ -12,11 +12,12 @@ below or prefix any `mp-units` URL (main branch, other branches, issues, PRs, ..
## Download, Build, Install
Alternatively, please refer to our official docs for [download, build, and install instructions](https://mpusz.github.io/units/usage.html) if you want to setup a development environemnt on your local machine.
Alternatively, please refer to our official docs for [download, build, and install instructions](https://mpusz.github.io/units/usage.html) if you want to setup a development environment on your local machine.
## Where to start?
If you are looking for a good issue to start with, please check the following:
- [good first issue](https://github.com/mpusz/units/labels/good%20first%20issue) - issues that should be pretty simple to implement.
- [help wanted](https://github.com/mpusz/units/labels/help%20wanted) - issues that typically are a bit more involved than beginner issues.
- [high priority](https://github.com/mpusz/units/labels/high%20priority) - things to fix ASAP but often of higher complexity.
@@ -26,6 +27,7 @@ If you are looking for a good issue to start with, please check the following:
We intend to use `clang-format` when it finally learns what a C++ concept is :wink:.
Until then, please code alike what is there already:
- 2 spaces for indentation
- no indentation for namespaces
- types, functions, variables naming in a `standard_case`