Перейти к содержанию

Создание PR

Before starting work:

  1. Ensure that there is a fork of the necessary OCA repository in the your repositories and that it contains the branch of the version you need.
  2. If there is a fork, clone it to your workspace.
  3. if there is no fork, Inform the person in charge, go back to point 2

Getting started:

  1. Go to the cloned repo and switch to the branch of the version you need assuming this is the parent branch
  2. Create a working branch from you parent branch according to the rules: -t-short-task-description

During work:

  1. Before pushing and opening a PR, ensure that module name, file names, variables, and XML IDs comply with OCA Guidlines
  2. If it's a new module, ensure that it contains a README directory with a description of the new module and all necessary files.
  3. If it's a modified module, ensure that all changes are reflected in in the corresponding files in the README folder.
  4. Contributing rules:
    • If you are ADD a new module, you must add yourself to "maintainers" and OCA to "authors" on manifest as well.
    • If you are ADD a new module or making significant changes in existing one, add to CONTRIBUTORS.rst:
    • Module migration it is not a significant change
  5. Ensure that 'pre-commit -a' does not return any errors.
  6. Ensure that all changes are saved (committed).
  7. Ensure that your branch contains only one module.
  8. Update the parent branch, rebase your branch to include all changes that have accumulated during your work, and squash the commit. Name the commit message according to OCA rules.

Opening a PR:

  1. Ensure that you are opening a PR in the correct repository.
  2. Fill out the PR message field on Github with content that reflects the purpose of the PR. If the PR is made to close an issue, include a link to the issue.