edx/configuration CCP Committers Guidelines
- lcicchese (Deactivated)
- Feanil Patel
- Jeremy Ristau
- Sarina Canelake (Do Not Use) (Deactivated)
This page is outdated and will be archived. The updated version of this document lives here: Merge Guidelines for Coding Core Contributors
Context
Groups of individuals with merge rights to one or more public repositories in the edx GitHub organization include:
members of the Core Contributor Program (Committers) (outside of edX),
employees of edX, and
contractors of edX.
Observation and monitoring of deployed changes can currently only be done by edX employees and contractors. Despite this, we want to empower community core contributors to merge changes without relying on an edX employee to “push the button” for them. So, this page exists to communicate opportune time windows for merging to different repositories.
CCP Committers: Please consider these guidelines in conjunction with those listed in Committer reviews and ownership, as well as any understandings you’ve come to with your champions. As always, reach out to your champions or the #ccp-committers channel in the Open edX Slack with questions or concerns.
Guidelines for edx/configuration
When is edx/configuration deployed? | edx/configuration is continuously deployed to production. Upon merging a pull request, it is generally released to the Staging environment (http://courses.stage.edx.org ) within one hour and the Production environments (http://courses.edx.org and edge.edx.org) within two hours. |
|---|---|
What is the ideal merge window? | The best time to merge edx/configuration code is whenever you or your champion is prepared to respond issues related to the change, once it hits production ~2 hours later. For edX employees/contractors: this is generally M-F, within your team’s preferred working hours. (see below for more details) For CCP Committers: this is roughly the working hours of your champion(s). The edx/configuration Champions working hours are local to the UTC +05:00 timezone |
What should I do once I merge? | Committers should inform their champions about the merge. edX employees/contractors may post in the edX-Internal Slack |
Are there times merging is discouraged?
Please note, local holidays and weekends start/end at UTC +05:00
| Day of week | Dates |
|---|---|---|
Weekends | Saturdays and Sundays |
|
Holidays |
|
|
| Friday | February 5 |
| Tuesday | March 23 |
| Saturday | May 1 |
| Friday, Saturday, Sunday | May 14, 15, 16 |
| Wednesday, Thursday, Friday | July 21, 22, 23 |
| Saturday | August 14 |
| Thursday, Friday | August 18, 19 |
| Monday | September 6 |
| Tuesday | October 19 |
| Thursday, Friday | November 25, 26 |
Company Holiday Week | Friday → Sunday | December 24th → January 2, 2022 Reach out to your champion if you want to merge within this time period. |
FAQ’s
What is the ideal merge window? | CCP Committers: You likely have already worked something out with your champions. Generally speaking, you can merge to these repositories whenever you want to (taking into consideration the table above), presuming that the PR meets all review requirements. |
|---|---|
What should I do once I merge? | CCP Committers should inform their champions. edX employees/contractors should inform the owning team. Depending on the repository, you may need to deploy. |
Are there other times merging is discouraged? | At the moment, no. |