practices
Hudi | Practices & Guidelines Confidentiality If you have not signed an NDA with 10/10, U, Hudi, Calm Experts or any of its subsidiaries, you are not permitted to have access to this document nor any of its associated documents. If you are an employee or contractor with any of these companies or brands, you are bound by your Employment Agreement, NDA, our Code of Conduct and Development Guidelines. Make sure you have refreshed your memory on all these internal guidelines before reading this document or working on this project.
Intro If you are a developer, UI/UX Designer or project manager that means you are part of the Dev Nest team. Welcome, welcome to the Dev Nest team, here we focus on building the best apps and software anyone has seen, we want to show not only our clients but the world what good software looks like, to accomplish that we follow strict and rigorous processes. Preparation Research Documentation If you are creating a new project, always create a README.md with the following instructions How to run your project. How to install the dependencies. Other requirements, for example, if it needs node.js, which version. How to debug with vscode or other editors (optional but good if you can). Other information that is useful for developers that are new to your project.
If you’re using environment variables with sensible data (like database credentials) don’t upload them to GitHub, create a .env.example with the variables keys but without the values.
On your code, if you’re using Flutter, consider their documentation guidelines https://dart.dev/guides/language/effective-dart/documentation
User Interface Design User Experience Design Development Architecture Clean Architecture https://youtube.com/playlist?list=PLB6lc7nQ1n4iYGE_khpXRdJkJEp9WOech https://resocoder.com/flutter-clean-architecture-tdd/
Clean code Articles: https://calmexperts.com/clean-code-what-is-it/ https://calmexperts.com/clean-code-generals/ https://calmexperts.com/clean-code-functions/ https://calmexperts.com/clean-code-names-and-comments/ Video in Portuguese explaining clean code: https://www.youtube.com/watch?v=TA7M4IBEF9E Videos in English explaining clean code: https://youtube.com/playlist?list=PLmmYSbUCWJ4x1GO839azG_BBw8rkh-zOj
Git patterns https://seesparkbox.com/foundry/semantic_commit_messages
APK’s patterns Every time we generate a new APK, we should change the version inside pubspec.yaml, and add to the APK title the same number. Branch Alfa - Big chances that are ready to be published (public release) - 1.0.0 Branch Beta - Medium changes (internal release) - 1.1.0 Branch Master - Very small changes (internal release) - 1.1.1 Branch Dev - Development only Github Copilot Register for the preview of Github Copilot https://copilot.github.com/
When you receive the invite in your email, install it on your vscode. Frontend State Management When it comes to frontend development we use 90% Flutter, in some rare occasions we might use other frameworks or languages. In terms of state management we are using Riverpod, exclusively Riverpod, make sure to get familiar with it. Backend