Hermes
/
Hermes
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Create design docs

main
Erin Nova 2022-05-12 14:24:45 +00:00 committed by GitHub
parent 62a5301114
commit d276910f0d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
DESIGN.md Normal file
View File

@ -0,0 +1,13 @@
# Design Docs
## Frontend
Make sure to follow the [GNOME Human Interface Guidelines](https://developer.gnome.org/hig/).
1. **Accessibility:** Software should be useable by everyone, this includes translations, screen reader support, streamlined UX, good contrast, and keyboard shortcuts, among other things.
2. **User Friendly:** Software should be simple for users to understand and navigate, even for non-technical users. It should never do anything without being explicitely specified by the user.
## Backend
1. **Document:** Comment your code! Don't be overly descriptive with comments *everywhere*, but have verbose comments in necessary positions. Also, it would be nice to make blog posts or something about the process, any problems you encounter, etc.
2. **Format:** Use `cargo fmt` before you commit in order to keep a consistent code style.
3. **Organize:** Keep similar functions in different files, similar files in folders, etc. Separate functions to allow reuse.
4. **Simplify:** Keep it as simple and easy to understand as possible. Don't introduce new dependencies unless necessary, and try to pick more lightweight options. It should be able to run fine on even low end machines.