From f16e0868f6e1524a6e981ab7537d050b94ce0556 Mon Sep 17 00:00:00 2001 From: cpovirk Date: Fri, 18 Sep 2026 14:02:54 -0700 Subject: [PATCH] Format some Markdown. RELNOTES=n/a PiperOrigin-RevId: 984055579 --- CONTRIBUTING.md | 26 ++++++++++++-------------- README.md | 31 ++++++++++++++++--------------- 2 files changed, 28 insertions(+), 29 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 51438eaa..99a9c07e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. @@ -12,25 +11,24 @@ should be JUnit based tests and can use either standard JUnit assertions or Truth assertions and be added to `/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 diff --git a/README.md b/README.md index c4592ad9..96b1eee2 100644 --- a/README.md +++ b/README.md @@ -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