Skip to content

Commit 82b698d

Browse files
alanchiaotensorflower-gardener
authored andcommitted
Update docs on contributing and create initial maintainers doc.
PiperOrigin-RevId: 328425526
1 parent 168c113 commit 82b698d

File tree

2 files changed

+47
-5
lines changed

2 files changed

+47
-5
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,6 @@ again.
2121

2222
## TensorFlow Model Optimization Specific
2323

24-
### Style
25-
Please refer to [TensorFlow's style guide](https://www.tensorflow.org/community/contribute/code_style). Don't forget to run pylint.
26-
2724
### Contributing Whole Techniques
2825

2926
See these [guidelines](CONTRIBUTING_TECHNIQUE.md).
@@ -47,9 +44,17 @@ are good for new contributors.
4744
These guidelines seek to prioritize efforts that would benefit the community the most.
4845
Feedback is welcome.
4946

47+
### Style and Practices
48+
* Please refer to [TensorFlow's style guide](https://www.tensorflow.org/community/contribute/code_style). Don't forget to run pylint.
49+
50+
Unless agreed upon with the project maintainer in the issue or PR, the following are necessary to
51+
merge a PR.
52+
* Unit tests for behavioral changes. Keep in mind that unit tests that take a long time to run also make it harder to contribute.
53+
* New features and major bug fixes, when ready to share with users, should come with a modification to the [release notes for the next release](RELEASE.md).
54+
* Documentation changes for https://www.tensorflow.org/model_optimization, possibly making a note that something will only be available in the next release after X.Y.Z.
55+
* Cleanup of commit history by [squashing noisy commit messages](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History).
5056

51-
New features and bug fixes for documented features should come with a
52-
modification to the [release notes](RELEASE.md).
57+
It is okay to not include all of the above in the initial PR, especially if early feedback is desired first.
5358

5459
## Code reviews
5560

MAINTAINING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
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

Comments
 (0)