Everyone is welcome to contribute to the VOST application, including adding new screens, fixing current issues or suggesting enhancements.
To do so, please read the following sections:
A new feature should have the enhanchement label, with a title describing the new feature (“Add new endpoints for VOST - gas stations”).
If the feature is an UI improvement or a new screen, please provide a wireframe of the screen, which can be made with apps such as MockFlow WireframePro - Editor.
The issue message should explain what the feature is going to change in the app and possible conflicts (“The new endpoints will change the list item in the Home Screen”).
When filing a bug, please follow the Github Issue Template Guideline
If you are going to work on an issue, please let others know that by commenting the issue page. We will then assign it to you.
When creating a Pull Request, please make sure your code follows the Style Guide.
This project follows the GitFlow structure in the git tree, so when creating a new feature or fixing an issue, please create the appropriate branch in the development branch. When your feature is finished, merge it back into development and create your pull request.
Additionally, each commit message must follow this set of rules:
- Reference the issue that you are fixing/adding as a feature
- Explain what the commit does (“Fixes issue #1), “Adds a button to the bottom bar for ‘Home’”)
- Use the present tense (“Add feature” not “Added feature”)
- Use the imperative mood (“Move cursor to…” not “Moves cursor to…”)
When creating a pull-request to the VOST repo, you must:
- Format the code with
dartfmt - Comment any added Functions and Methods according to the Official Dart Recommendations for commenting code.