commit | 5e2ae014581bcaf75710e0794badf5b7001cbf28 | [log] [tgz] |
---|---|---|
author | Tamas Cservenak <tamas@cservenak.net> | Mon Dec 11 10:18:58 2023 +0100 |
committer | GitHub <noreply@github.com> | Mon Dec 11 10:18:58 2023 +0100 |
tree | 14879cfacd22ffd1577262a41f1fe40f6f62820c | |
parent | 09ba0b95d1a880dc65eeea2d94a99e7708d9f052 [diff] |
[MRESOLVER-443] Integrate tool into build (#385) Simply invoke it as very last step of build to generate the documentation. Ideally, this will produce _same output_ hence there will be no side effect (no local change). But in case page is outdated (needs update) the local checkout becomes dirty and would prevent release for example. This is not "final" solution, but would work IMHO. Current issue with tool is that: * it must have access to up-to-date class files (to javap them), hence it runs as last module of multi module build * it must process WHOLE project, so to say "aggregate" output, it cannot run per module --- https://issues.apache.org/jira/browse/MRESOLVER-443
You have found a bug or you have an idea for a cool new feature? Contributing code is a great way to give something back to the open source community. Before you dig right into the code, there are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
We accept Pull Requests via GitHub. The developer mailing list is the main channel of communication for contributors. There are some guidelines which will make applying PRs easier for us:
git diff --check
before committing.[MRESOLVER-XXX] - Subject of the JIRA Ticket Optional supplemental description.
mvn -Prun-its verify
to assure nothing else was accidentally broken.If you plan to contribute on a regular basis, please consider filing a contributor license agreement.
For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in JIRA. In this case, it is appropriate to start the first line of a commit with ‘(doc)’ instead of a ticket number.