Skip to content

Commit

Permalink
doc: Fix some typos in CONTRIBUTING.md; Add note on editorconfig
Browse files Browse the repository at this point in the history
Signed-off-by: Siddharth Chandrasekaran <sidcha.dev@gmail.com>
  • Loading branch information
sidcha committed Dec 7, 2024
1 parent e1d052c commit 442da4b
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,19 @@ transparent as possible, whether it's:
- Submitting a fix
- Proposing new features

## We Develop with Github
## We Develop with GitHub

We use github to host code, to track issues and feature requests, as well as
accept contributions in the form of pull requests.
We use GitHub to host code, to track issues and feature requests, as well as
accept contributions in the from of pull requests.

You start off by creating a fork of goToMain/libosdp to <your-username>/libosdp
and then clone from your fork (or add another remote to existing clone). After
that, you can create a branch from master and make your code changes there and
push your changed to origin (if you added a remote earlier, then to that
remote). Now when you visit github page for <your-username>/libosdp, you should
see an option to raise a pull requst to goToMain/libosdp.
remote). Now when you visit the GitHub page for <your-username>/libosdp, you
should see an option to raise a pull request to goToMain/libosdp.

You can read more about github development work flow [here][1] and
You can read more about GitHub development work flow [here][1] and

## Any contributions you make will be under the project's license

Expand All @@ -43,7 +43,11 @@ maintainers if that's a concern.

## Use a Consistent Coding Style

Look around, make your code fit in. We mostly follow the kernel coding style
with minor variations.
Look around, make your code fit in. We mostly follow the [Linux kernel coding
style][2] with minor variations. To keep things some what sane, install
[editorconfig][3] plugin in your favorite editor -- this should handle a lot of
unintended white-space issues.

[1]: https://guides.github.com/introduction/flow/index.html
[2]: https://www.kernel.org/doc/html/latest/process/coding-style.html
[3]: https://editorconfig.org/

0 comments on commit 442da4b

Please sign in to comment.