Skip to content

Commit 0e1363e

Browse files
authored
docs: add simple design guidelines section (#1540)
Signed-off-by: Adam Setch <[email protected]>
1 parent 9441360 commit 0e1363e

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,11 @@ The release process is automated. Follow the steps below.
7070
8. Create a [New Milestone][github-new-milestone] for upcoming release.
7171
9. A new homebrew cask will be [automatically published][homebrew-cask-autobump-workflow] (workflow runs ~3 hours)
7272

73+
### Design Guidelines
74+
75+
1. Use sentence case where possible
76+
2. Use GitHub's [Octicons][github-octicons] for iconography
77+
7378
### Project Philosophy
7479

7580
This project is a tool for monitoring new notifications from Github. It's not meant to be a full-featured Github client. We want to keep it simple and focused on that core functionality. We're happy to accept contributions that help us achieve that goal, but we're also happy to say no to things that don't. We're not trying to be everything to everyone.
@@ -90,6 +95,7 @@ This project is a tool for monitoring new notifications from Github. It's not me
9095
[github-milestones]: https://github.com/gitify-app/gitify/milestones
9196
[github-new-milestone]: https://github.com/gitify-app/gitify/milestones/new
9297
[github-new-release]: https://github.com/gitify-app/gitify/releases/new
98+
[github-octicons]: https://primer.style/foundations/icons
9399
[homebrew-cask-autobump-workflow]: https://github.com/Homebrew/homebrew-cask/actions/workflows/autobump.yml
94100
[jest-website]: https://jestjs.io/
95101

0 commit comments

Comments
 (0)