From 25d6eb5cc011c120fdd65c25fa7ca9aba827a996 Mon Sep 17 00:00:00 2001 From: Adam Setch Date: Wed, 18 Sep 2024 08:42:56 -0400 Subject: [PATCH] docs: add simple design guidelines section Signed-off-by: Adam Setch --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a3a7f0c4e..875ed29b7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -70,6 +70,11 @@ The release process is automated. Follow the steps below. 8. Create a [New Milestone][github-new-milestone] for upcoming release. 9. A new homebrew cask will be [automatically published][homebrew-cask-autobump-workflow] (workflow runs ~3 hours) +### Design Guidelines + +1. Use sentence case where possible +2. Use GitHub's [Octicons][github-octicons] for iconography + ### Project Philosophy 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 [github-milestones]: https://github.com/gitify-app/gitify/milestones [github-new-milestone]: https://github.com/gitify-app/gitify/milestones/new [github-new-release]: https://github.com/gitify-app/gitify/releases/new +[github-octicons]: https://primer.style/foundations/icons [homebrew-cask-autobump-workflow]: https://github.com/Homebrew/homebrew-cask/actions/workflows/autobump.yml [jest-website]: https://jestjs.io/