Quickstart - euvm-odoo/internal-documentation GitHub Wiki
Quickstart
All development requests are managed under the project PSUS - Tech Quickstart
Project leaders:
Step by Step
Follow these steps when working on a Quickstart development
1. 🆕 Starting a new dev
- Review Dev Spec
- Download a database dump to have data to test locally.
- Optional: Have a 15 minute call with the BSA. This will reassure that dev Spec is clear and understood as custeomer intended. Also align expectations on how much time dev will take.
- Move task to Development stage
- Send email template
C02
(except MX developments) - Create a new branch for the development
- For SH projects, create a new branch in the project's repo using this convention
- For SaaS projects, create a new branch in the repo odoo-ps/psus-custom using this convention
2. ⏳ During development
- We recommend timesheeting according to UAT testing points
- Make sure to create unit tests
- Make sure you follow these coding guidelines
3. 💻 Creating the pr
- Optional: Show the functionality to the BSA before creating the PR to avoid future corrections and a new pr
- Move task to Code Review stage
- Squash your commits to keep a cleaner git history
- Make sure you follow these git guidelines
- Create a pull request from your branch to the staging branch. Please note that GitHub automatically targets the production/main branch when creating PRs.
- Request a review from @pr-police in #pr-police in the Tech Services Discord Server
4. 👀 Solving PR corrections
- Resolve comments on GitHub
- Optional: Squash again to keep a cleaner git history
- If reviewer does not, ping them
5. ✅ PR Approved! And UAT
- Record a video or document on how the development works. This will help the Upgrade team later on. Add the video directly to the ticket
- Add the PR link at the end of the ticket
- Create a backup of the staging branch
- SH projects:
- Before merging with staging branch, ask the BSA. They could be doing some configuration and pushing changes will do a rebuild, causing their changes to be gone.
- SaaS projects:
-
Important! DO NOT merge your branch. The PR is for reviewing purposes.
- Create a duplicate of the customer's database
- Create a zip with the development
- Access the duplicate database with developer mode and go to Apps > Import Module and import the zip file
-
- Send email template
C03
(except MX developments). Make sure to include the link to the staging branch database - Move task to User Acceptance Testing stage
- If an error was found during this stage, return to before doing the PR
6. 🚀 Deploying
- Coordinate a deployment time with the BSA as after deployment, the database would be down for a few minutes
- Make sure your changes are squashed into a single commit
7. ⚠️ Running out of time and change requests
- In the following link, there is information about the policies of the Quickstart department. It includes what to do in case you run out of hours, what to do in case of a change request, when to pause dev and other important points.
https://odoo-ps.github.io/psus-process/docs/project/qs/policies/#infopolicies-document