Skip to content

Commit

Permalink
docs: improve formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
ThisAMJ committed Sep 25, 2024
1 parent 1364394 commit eb0e7c8
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,9 @@

### Quick Tutorial with git

- Fork this repository on GitHub
- [Fork this repository on GitHub](https://github.com/p2sr/SourceAutoRecord/fork)
- `git clone https://github.com/<your_account>/SourceAutoRecord`
- `cd SourceAutoRecord`
- `git remote add upstream https://github.com/p2sr/SourceAutoRecord`
- `git fetch remotes/upstream/master`
- `git checkout -b feature/something remotes/upstream/master`
Expand All @@ -72,19 +73,19 @@

PRs will be squashed in the end anyway.

- git checkout -b feature/something remotes/upstream/master
- git merge --squash some-branch
- `git checkout -b feature/something remotes/upstream/master`
- `git merge --squash some-branch`
- *Resolve merge conflicts*
- git commit -m "New something"
- git push origin feature/something
- `git commit -m "New something"`
- `git push origin feature/something`

## Coding Style

Mostly follows [Webkit Style Guide](https://webkit.org/code-style-guidelines) with some exceptions:

- PascalCaseForClassesNamespacesStructsAndFunctions
- camelCaseForPropertiesAndVariables
- _LeadingUnderscoreForTypeAliases
- \_LeadingUnderscoreForTypeAliases

A `.clang-format` file is included. I'd highly recommend using an extension:

Expand Down

0 comments on commit eb0e7c8

Please sign in to comment.