Last updated: 2023-07-15
Befere contributing, you must read the Code of Conduct.
If you want to contribute to this project, you can do so by forking the repository, and then creating a pull request. You can also create an issue if you find a bug or have a feature request.
Any code you write must be licensed under GPL-3.0. See LICENSE for more information.
You can work on whatever you want from Projects/Leomard. If something is in the "In progress" column, please do not work on it, unless you have been assigned to it. First table is for the current version, those features are the most important. Please avoid working on features that are in the "Future" column or the next update column, unless you have been assigned to it. You can also work on stuff from the "Bugs" column.
You can also test stuff that is in the "Testing" column. If you find any bugs related to the stuff in the "Testing" column, please open an issue. If no issues have been reported regarding an item in this column in 7 days after the update containing that item has been released, the item will be moved to the "Done" column.
If you want to work on something that is not in the project, please create an issue first. Your idea will be discussed, and if it is accepted, it will be added to the project.
The project is divided into three branches:
master: The main branch. This branch is used for releases only. Do not commit directly to this branch.dev: The development branch. This branch reflects the currently worked on version in the project's table. Do not commit directly to this branch.hotfix: The hotfix branch. This branch is used to fix bugs in the current version. Do not commit directly to this branch.
Please follow the Swift API Design Guidelines. If you find any violations, please feel free to open a pull request.
The main project folder is divided into following subfolders:
Assets: Contains the assets used in the app.AppStorage: Contains the source code of whatever is saved in the app storage.Models: Contains the source code of the models used in the app.Models/Leomard: Used only by LeomardModels/Lemmy: Models provided by the Lemmy API.Services: Contains the source code of the services used in the app.Utils: Various utilities used in the app.Views: Contains the source code of the views used in the app.
The code is build around LemmyHttp API. The API is documented here.
Only store one struct/class per file, unless the struct/class is a substruct/subclass of another struct/class, or that struct/class is only used within the file. If that's the case, mark the struct/class as fileprivate.
Never create a new instance of UserPreferences or SessionStorage structs, always use the shared instance.
Please pass services from ContentView into the other views (aka: dependency injection), instead of creating new instances of the services in the other views.
Remember to use LazyVStack instead of VStack when loading a lot of elements.
Always prefer struct over class, unless you need inheritance or reference semantics.
Always prefer let over var, unless you need to mutate the variable.
Do not use abbreviations in variable and method names, unless the abbreviation is well known (e.g. URL). Names should be descriptive. Do not use m as a variable name, use message instead
Feel free to refactor the code, if you think it can be improved, but don't overcomplicate it. The code should be easy to read and understand.
While the code should explain itself, if something is not clear, please add a comment explaining what the code does.
I sometimes may not follow my own guidelines (sorry!). If you find any violations, please feel free to open a pull request.
While creating Forms for API requests, never add "auth". This is handled by RequestHandler.
Any artwork you create must be licensed under CC-BY-SA-4.0. If your art will be used in the app, you will be credited in the app and in README.md.
While not necessary, it's recommended to also include art's source file (e.g. .afdesign, .xcf, .psd, etc.) in the pull request.
Do not plagiarize other people's work. Do not use someone else's work without their permission. Inspiration is fine, but do not do the "can I copy your homework" thing.
Trying to pass someone else's work as your own will result in a ban from the project.
No generally offensive content is allowed. No NSFW content is allowed. No noninclusive content is allowed. No illegal content is allowed. No content that is not related to the project is allowed.
If you want to contribute artwork, please open an issue first, so we can discuss it, or contact me via email: mail@kfigura.nl
You can submit app icons, screenshots, or any other artwork you think would be useful. (It would be cool to have installer artwork, or perhaps login screen artwork. Although it's not something I am actively chasing.)
Specifications:
- App Installer Art: 800x600px, 72dpi, PNG
- App Icon: 1024x1024px, 72dpi, PNG/SVG, must follow macOS App Icon Guidelines
- Login Screen Art: TBD
As for now, only English is supported and no translations are planned, until the app is more stable. This is because the app is still in early development, and the translations would have to be updated every time a new feature is added. An announcement will be made when the work on translations starts.
Thank you for reading this, and thank you for contributing to this project! If you have any questions, feel free to open an issue, or contact me via email: mail @kfigura.nl
This project is bound to laws of the Netherlands. Any disputes will be settled in the court of the Netherlands.