|
| 1 | +This document is for maintainers. |
| 2 | + |
| 3 | +It is a work in progress and suggestions are welcome. |
| 4 | + |
| 5 | +# Triaging |
| 6 | +A issue or PR should only be assigned to someone if they would be actively working on |
| 7 | +it or would be working on it shortly. This avoids the scenario when we think |
| 8 | +everything is being addressed when that is not the case, particularly when people are |
| 9 | +busy, which may cause issues to invisibly languish. |
| 10 | + |
| 11 | +The [maintainer for a particular |
| 12 | +technique](https://github.com/tensorflow/model-optimization#maintainers) is |
| 13 | +responsible for that technique. |
| 14 | + |
| 15 | +Github PRs |
| 16 | +- The maintainers should watch out for PRs, filtered by the corresponding |
| 17 | + technique label. For example, the label for quantization-aware training is |
| 18 | + [here](https://github.com/tensorflow/model-optimization/pulls?q=is%3Apr+is%3Aopen+label%3Atechnique%3Aqat+). |
| 19 | + This labeling is automated |
| 20 | + [here](https://github.com/tensorflow/model-optimization/blob/master/.github/workflows/labeler.yml). |
| 21 | + |
| 22 | +Github Issues |
| 23 | +- The maintainers should skim through issues and attach the appropriate technique label. This has not been automated yet. |
| 24 | +- Use other labels as needed, according to [CONTRIBUTING.md](https://github.com/tensorflow/model-optimization/blob/master/CONTRIBUTING.md). |
| 25 | + |
| 26 | +# Code Reviews |
| 27 | +Ensure that contributions adhere to the guidelines suggested in |
| 28 | +[CONTRIBUTING.md](https://github.com/tensorflow/model-optimization/blob/master/CONTRIBUTING.md). |
| 29 | +Comments that are frequently made in PRs should be added there. |
| 30 | + |
| 31 | +If there are public API changes, please attach the ["api-review" |
| 32 | +label](https://github.com/tensorflow/model-optimization/pulls?q=is%3Apr+is%3Aopen+label%3Aapi-review) |
| 33 | +for a closer look from the TFMOT team. |
| 34 | + |
| 35 | +Once you think a PR is ready to merge, apply the ["ready to pull" |
| 36 | +label](https://github.com/tensorflow/model-optimization/pulls?q=is%3Apr+is%3Aopen+label%3A%22ready+to+pull%22) |
| 37 | +and someone will merge it. |
0 commit comments