StarlingX/CodeSubmissionGuidelines
< StarlingX
Revision as of 00:59, 4 September 2018 by Ghada.khalil (talk | contribs)
StarlingX Code Submission Guidelines
- Use Gerrit for StarlingX code reviews
- Add the core reviewers for the affected sub-project to the review
- The core reviewers are listed on each sub-project wiki pages. The list of sub-projects is available here
- All code changes must be pushed to master first and then cherry-picked to the appropriate release branch as needed
- Exception: Feature branches used during development
- Link your code change to a StoryBoard Story or Launchpad Bug
- For traceability, always link your code change to a story or bug. Gerrit will update the status of the story/bug automatically once the code is merged.
- Linking to StoryBoard Stories: Specify the story and task ID in the commit message as follows:
Story: $story_id Task: $task_id
Example: https://review.openstack.org/#/c/590083/
- Linking to Launchpad Bugs: Specify the Bug ID in the commit message as follows:
Closes-Bug: $bug_id
Example: https://review.openstack.org/596305
- Pre-Submission / Pre-Gerrit Testing
- At a minimum, make sure the code builds and runs
- Verify basic functional testing on a builtISO (ensure the new code get executed)
- Include automated unit tests when applicable. As we build out the Zuul infrastructure, those tests will run per merge
- Consult with the component core reviewers for any required/recommended testing