Skip to content

Commit f4c46b6

Browse files
authored
HOWTO code formatting (#685)
## Summary Describing code formatting in the getting started
1 parent c07a40f commit f4c46b6

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

GETTING_STARTED.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,30 @@ If it's still not building, or if you find other noteworthy dependencies not lis
2222

2323
Since the Beeminder backend/web application isn't open source (yet), you'll need to ask us to be added to the private repo if you want to be able to point the iOS app at localhost:3000. You can also create a test account/goal on beeminder.com to test against.
2424

25+
#### Code Formatting
26+
27+
The codebase is formatted using swift-format. A check on CI will fail when the code of a meege request does not comply.
28+
29+
##### lane
30+
31+
A lane in fastlane can be used to format the code.
32+
33+
34+
##### pre-commit
35+
The [pre-commit tool](https://pre-commit.com) can be used to configure git with the pre-commit hook provided in the repository.
36+
37+
Install the tool:
38+
```
39+
brew install precommit
40+
pre-commit --install
41+
```
42+
43+
It will now run at the start of a git commit.
44+
It can also be run manually:
45+
46+
`pre-commit run --all-files`
47+
48+
2549
#### Contributing
2650

2751
See [Contributing](CONTRIBUTING.md) for more.

0 commit comments

Comments
 (0)