Improve contribution documentation (#572)

- Introduce a `./run-full-build.sh` script.
- Explicitly mention that users should run this script before opening a pull
  request.
- Emphasize that many build warnings can be resolved automatically.
- Introduce a `SECURITY.md` file as suggested by GitHub.
This commit is contained in:
Stephan Schroevers
2023-04-13 09:10:56 +02:00
committed by GitHub
parent 6514236514
commit 977019c5bf
4 changed files with 92 additions and 11 deletions

21
run-full-build.sh Executable file
View File

@@ -0,0 +1,21 @@
#!/usr/bin/env bash
# Builds the project twice: once against the original Error Prone release,
# using only Error Prone checks available on Maven Central, and once against
# the Picnic Error Prone fork, additionally enabling all checks defined in this
# project and any Error Prone checks available only from other artifact
# repositories.
set -e -u -o pipefail
settings="$(dirname "${0}")/settings.xml"
mvn clean install \
-s "${settings}" \
$@
mvn clean install \
-s "${settings}" \
-Perror-prone-fork \
-Pnon-maven-central \
-Pself-check \
$@