Skip to content

Commit

Permalink
add note about Periphery to CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
joshuatbrown committed Mar 14, 2024
1 parent acb1580 commit 4822592
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ If you'd like to contribute code to the main branch of Nos, it's best to check w

We use SwiftLint to enforce many of our style conventions. When it comes to naming conventions we follow the [Swift API Design Guidelines](https://www.swift.org/documentation/api-design-guidelines/).

[Periphery](https://github.com/peripheryapp/periphery) allows us to detect and delete unused code. One great way to contribute to Nos would be to run periphery, delete unused code, test the app, then submit a PR. We'd really appreciate it!

### Opening a Pull Request

For now `main` is the main branch and code improvements are made in topic branches that get merged into it.
Expand Down

0 comments on commit 4822592

Please sign in to comment.