What to do before and after PR - ITA-Dnipro/PyDataCenter5000 GitHub Wiki
Basic Rules
- Never push to
develop
/main
! Always create pull requests. - Don't ask for review if unit tests are failing. If they are failing because of bugs in tests themselves - fix tests and comment on that in your commit message.
- If Codecov is failing, do you understand why? Is there a good reason you're adding something that is not covered with tests? Don't merge unless your answer to both questions is YES.
- Don't merge your branch unless checks succeed (see above for clarification).
- Add three reviewers to your pull request: two interns and one mentor.
Every day, before starting work
We open our IDLE, in terminal go to PyDataCenter5000 directory, and run this commands
git checkout develop
git fetch
git pull
git checkout YOUR_BRANCH_NAME
git merge develop
Fix merge conflicts in your IDLE, if they appeared. These steps pull all current updates from develop branch and merge them into your branch. It helps you to be on the same wavelength with other developers, and help you to prevent huge merge conflicts.
Before PR
Repeat all the steps from above. And ONLY AFTER RESOLVING MERGE CONFLICTS - create a PR.
When PR is ready
Make sure, that your PR pass all tests. You should see GREEN CHECK MARK at the bottom of the page with your PR Like this:
What to do if tests fails?
Find a red cross. Like this:
Click on it. You should see a new page with test report. Find a red cross here, and read message about mistake
Fix the mistake locally, than push new commits. After you see that all tests have passed (green check mark) - write about your PR to discord.