-
Notifications
You must be signed in to change notification settings - Fork 10
Submission Policy
Joe Hegarty edited this page Feb 28, 2019
·
5 revisions
This document describes the submission policy for the Orbit project.
- In order to clarify the intellectual property license granted for contributions to EA open source projects you must sign the Contributor License Agreement (CLA).
- All changes must adhere to the Orbit Coding Standards.
- Changelists should be as small and independent as possible. Avoid multi-feature changelists. Ideally, you should be able to remove each changelist by itself.
- Do not work for weeks at a time and then check in all your work. Account for the possibility that you might get called away unexpectedly and somebody will have to pick up your work. Check your work in incrementally. As a general guideline, a changelist should contain no more than three days worth of work, ideally one day.
- All changelists should identify the task or the bug that corresponds to the work. They should also describe the actual work done. This is crucial when looking for bugs or managing integrations.
- Enforces a complete understanding of the feature.
- Help reviewers identify what use cases were not covered by the author.
- Easier to hand-over to other developers.
- All changelists must be reviewed via a pull request.
- Functional tests that exercise your code must accompany each check in
- You should manually exercise any tests that may be relevant
- You cannot check in any code that decreases the quality of the product.
- In cases where you are replacing one system with another, it is preferable that either the replacement is equal to or greater than the system it is replacing, or that you leave both systems in place and allow users to switch to your replacement.
Developed by Electronic Arts. Licensed under the BSD 3-Clause License.