Add licensing & plurality info to DESIGN.md

main
Erin Nova 2022-05-12 14:45:44 +00:00 committed by GitHub
parent 5d77702711
commit 291e1700d8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 0 deletions

View File

@ -19,6 +19,7 @@ Make sure to follow the [GNOME Human Interface Guidelines](https://developer.gno
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.
3. **Plurality Friendly:** All UI should work well with multiple users, always having a way to change & view the active 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.
@ -26,3 +27,6 @@ Make sure to follow the [GNOME Human Interface Guidelines](https://developer.gno
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.
5. **Conventions:** Use proper Linux & SSB conventions. Store configs in `~/.config`, data in `~/.local/share`, etc. *Don't* use `~/.ssb`, as [reccomended](https://www.manyver.se/faq/each-app-own-folder/) by Manyverse devs.
## Licensing
All original code and assets will be licensed under the [CNPLv7+](https://thufie.lain.haus/NPL.html) copyfar-left license