diff options
| author | sebright <sebright@google.com> | 2018-04-18 17:37:56 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-04-18 17:37:56 -0700 |
| commit | d3269b6c4ceeb69f15c5d07c4b514688caf009ca (patch) | |
| tree | de9967babe45543025d6b03543893587d6d22466 /CONTRIBUTING.md | |
| parent | 9e518c6743ef46d0d1e18b5927c7dfc754b6d835 (diff) | |
| parent | cffa220c13ee5a932ecb933c28872527419d75b0 (diff) | |
| download | platform_external_opencensus-java-d3269b6c4ceeb69f15c5d07c4b514688caf009ca.tar.gz platform_external_opencensus-java-d3269b6c4ceeb69f15c5d07c4b514688caf009ca.tar.bz2 platform_external_opencensus-java-d3269b6c4ceeb69f15c5d07c4b514688caf009ca.zip | |
Merge pull request #1137 from sebright/checkstyle-import-control
Control package dependencies with Checkstyle.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 58137796..c76ccd3e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -108,6 +108,17 @@ applied to types. However, it uses `javax.annotation.Nullable` in API method signatures whenever possible, so that the annotations can be uncommented and be included in .class files and Javadocs. +### Checkstyle import control + +This project uses Checkstyle to specify the allowed dependencies between +packages, using its ImportControl feature +(http://checkstyle.sourceforge.net/config_imports.html#ImportControl). +`buildscripts/import-control.xml` specifies the allowed imports and contains +some guidelines on OpenCensus' inter-package dependencies. An error messsage +such as +`Disallowed import - edu.umd.cs.findbugs.annotations.SuppressFBWarnings. [ImportControl]` +could mean that `import-control.xml` needs to be updated. + ## Proposing changes Create a Pull Request with your changes. The continuous integration build will |