Document how to start contributing and general documentation
🚀 Feature Proposal
A contributor should be able to follow a detailed documentation how to setup the environment and how to contribute
Technical Details
Should be either updated or created
-
CONTRIBUTION.md -
README.md
The documentation should contain the following points
-
Commit style Conventional Commits -
GitHooks + Ruby GitHooks -
How to create issues/bugs/mrs -
Flutter lint -
Testing occasions (on complex features) -
Structure of the app e.g. flows, modules, core, statemanagement: riverpod -
Needed sdks (e.g. ruby, dart (null safty) etc.) -
How to generate code -
iOS/Android Differences are respected PlatformWidgets
Any questions regarding this issue: @maurice.kraus
Edited by Maurice Kraus