Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 1.66 KB

PROJECT_FLOW.md

File metadata and controls

45 lines (31 loc) · 1.66 KB

CHIP Project Flow

This section is intended to cover how CHIP uses GitHub Projects, Issues, Milestones, Releases, and Branches for program/project management in the code repository.

Issues

CHIP uses issues as simple problem descriptions or feature requests. All work contributed to the repository in the form of pull requests should be under the auspices of some open issue.

Pull requests

Pull requests should be small and address a single, specific change to the code base. They should be easy to review, as a "yes, that's better". Refrain from requesting review until all PR checks have completed successfully, lest you tire your reviewers.

Milestones

In CHIP parlance, a milestone is simply an expected due date or release.

Date-based milestones start with an "M" and have the form M3, M3.2, M4, etc. corresponding to the number of months since January 1, 2020, and generally mean the last Friday of that month. E.g. M1 corresponds to EOB January 24, 2020.

The form of the names of release-based milestone names are TBD, and may have flexible or changing dates.

Projects

Projects are collections of issues, pull requests, and notes intended to capture larger efforts that don't fit in issues, have multiple-subsystems involved, or may span multiple milestones. When constructing a new project, it's nevertheless important to think in terms of something that will eventually have an end, i.e. a definite scope.

Branches, releases, and general development flow

Master should always be CHIPs best branch. Release branches, once cut, are closed for any feature work. Software fixes for release branches must first land on master unless demonstrably infeasible.