This is an automated email from the ASF dual-hosted git repository.
sebb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-weaver.git
The following commit(s) were added to refs/heads/master by this push:
new ca5aa4a Fix up status URLs
ca5aa4a is described below
commit ca5aa4a665c9960dd52b517ed8e27ac7a36cf66f
Author: Sebb <s...@apache.org>
AuthorDate: Mon Oct 9 11:14:35 2023 +0100
Fix up status URLs
---
README.md | 34 ++++++++++++++++++++++++----------
1 file changed, 24 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index 86073fb..83ad316 100644
--- a/README.md
+++ b/README.md
@@ -25,7 +25,7 @@
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+======================================================================+
| |
- | 1) Re-generate using: mvn commons:readme-md |
+ | 1) Re-generate using: mvn commons-build:readme-md |
| |
| 2) Set the following properties in the component's pom: |
| - commons.componentid (required, alphabetic, lower case) |
@@ -43,10 +43,12 @@
Apache Commons Weaver
===================
-[](https://travis-ci.org/apache/commons-weaver)
+[](https://github.com/apache/commons-weaver/actions)
[](https://app.codecov.io/gh/apache/commons-weaver)
[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-weaver-base/?gav=true)
[](https://javadoc.io/doc/org.apache.commons/commons-weaver-base/2.0)
+[](https://github.com/apache/commons-weaver/actions/workflows/codeql-analysis.yml?query=workflow%3ACodeQL)
+[](https://api.securityscorecards.dev/projects/github.com/apache/commons-weaver)
Apache Commons Weaver provides an easy way to enhance compiled Java
classes by generating ("weaving") bytecode into those classes.
@@ -72,35 +74,47 @@ Alternatively, you can pull it from the central Maven
repositories:
</dependency>
```
+Building
+--------
+
+Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
+The required Java version is found in the `pom.xml` as the
`maven.compiler.source` property.
+
+From a command shell, run `mvn` without arguments to invoke the default Maven
goal to run all tests and checks.
+
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) is the main channel of
communication for contributors.
There are some guidelines which will make applying PRs easier for us:
+ No tabs! Please use spaces for indentation.
-+ Respect the code style.
++ Respect the existing code style for each file.
+ Create minimal diffs - disable on save actions like reformat source code or
organize imports. If you feel the source code should be reformatted create a
separate PR for this change.
-+ Provide JUnit tests for your changes and make sure your changes don't break
any existing tests by running ```mvn clean test```.
++ Provide JUnit tests for your changes and make sure your changes don't break
any existing tests by running ```mvn```.
If you plan to contribute on a regular basis, please consider filing a
[contributor license agreement](https://www.apache.org/licenses/#clas).
You can learn more about contributing via GitHub in our [contribution
guidelines](CONTRIBUTING.md).
License
-------
-This code is under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE.txt` file for required notices and attributions.
-Donations
----------
-You like Apache Commons Weaver? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Weaver? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/WEAVER)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
