Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 12 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Contributing
============
# Contributing

If you would like to contribute code to compile-testing you can do so through
GitHub by forking the repository and sending a pull request.
Expand All @@ -12,25 +11,24 @@ should be JUnit based tests and can use either standard JUnit assertions or
Truth assertions and be added to `<project>/src/test/java`.

Please make sure your code compiles by running `mvn clean verify` which will
execute both unit and integration test phases. Additionally, consider using
execute both unit and integration test phases. Additionally, consider using
http://travis-ci.org to validate your branches before you even put them into
pull requests. All pull requests will be validated by Travis-ci in any case
and must pass before being merged.
pull requests. All pull requests will be validated by Travis-ci in any case and
must pass before being merged.

If you are adding or modifying files you may add your own copyright line, but
please ensure that the form is consistent with the existing files, and please
note that a Google, Inc. copyright line must appear in every copyright notice.
All files are released with the Apache 2.0 license and any new files may only
be accepted under the terms of that license.
All files are released with the Apache 2.0 license and any new files may only be
accepted under the terms of that license.

Checkstyle failures during compilation indicate errors in your style and will
be displayed in the console output of the build (including in Travis-CI output),
or can be viewed in the `checkstyle-result.xml` file. To save yourself some
hassle, consider executing checkstyle first per: 'mvn checkstyle:checkstyle'.
It's fast, and will catch style errors early.
Checkstyle failures during compilation indicate errors in your style and will be
displayed in the console output of the build (including in Travis-CI output), or
can be viewed in the `checkstyle-result.xml` file. To save yourself some hassle,
consider executing checkstyle first per: 'mvn checkstyle:checkstyle'. It's fast,
and will catch style errors early.

Before your code can be accepted into the project you must sign the
[Individual Contributor License Agreement (CLA)][1].


[1]: https://developers.google.com/open-source/cla/individual
[1]: https://developers.google.com/open-source/cla/individual
31 changes: 16 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,29 @@
Compile Testing
===============
# Compile Testing

[![Build Status][ci-shield]][ci-link]
[![Maven Release][maven-shield]][maven-link]
[![Javadoc][javadoc-shield]][javadoc-link]

A library for testing javac compilation with or without annotation processors. See the [javadoc][javadoc-link] for usage examples.
A library for testing javac compilation with or without annotation processors.
See the [javadoc][javadoc-link] for usage examples.

License
-------
## License

Copyright 2013 Google, Inc.
```
Copyright 2013 Google, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```

[ci-shield]: https://github.com/google/compile-testing/actions/workflows/ci.yml/badge.svg?branch=main
[ci-link]: https://github.com/google/compile-testing/actions
Expand Down
Loading