Best practices for the generation of a Pull Request

Best practices

• When creating a Pull Request, include the NLP Global Team as reviewers of the process and, likewise, notify the APE Team.
• It is mandatory to create reduced PRs (per use case, per bug, etc.) in order to speed up the validation process.
• Do not modify configuration files during the Pull Request, excepting in case the pipeline has been changed or if any configuration adjustment is required for the system’s proper performance. If configuration files have been modified locally for testing purposes, get sure that they are not uploaded in the PR in order to avoid conflicts.
• It is recommended to specify different tasks in the PR, so the review progress can be marked:

• It is recommended to make a backup for those PRs modifying files that may conflict with other ones, or for large Pull Requests.
• If the use case is going to be available in different channels, check that the content and order of the training files is the same.