diff options
author | Kristen Kozak <sebright@google.com> | 2018-02-07 20:15:04 -0800 |
---|---|---|
committer | Kristen Kozak <sebright@google.com> | 2018-02-07 20:15:08 -0800 |
commit | b6aad9acbfc7fd5c16a3834aeea486eea5287f76 (patch) | |
tree | dfb3e0c0cd92ff5a1698c2a9c1eb3250a5959c8e /CONTRIBUTING.md | |
parent | 1d2c51b7d4d5475508622f0b3840bae3dab586de (diff) | |
download | opencensus-java-b6aad9acbfc7fd5c16a3834aeea486eea5287f76.tar.gz |
Recommend '@since' tags in the Javadoc section of CONTRIBUTING.md.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 83205980..2edc3664 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,6 +38,8 @@ We also follow these project-specific guidelines: (package-protected classes, private) MAY have javadoc, at the code writer's whim. It does not have to be complete, and reviewers are not allowed to require or disallow it. +* Each API element should have a `@since` tag specifying the minor version when + it was released (or the next minor version). * There MUST be NO javadoc errors. * See [section 7.3.1](https://google.github.io/styleguide/javaguide.html#s7.3.1-javadoc-exception-self-explanatory) |