Most of the documentation has been rewritten recently. The content minimum content we need is there but there is a lot that can be done to improve it.

If you'd like to contribute to the semantic-release project, helping with the following would be much appreciated:

• Fix typo, misspelling and gramatical mistakes
• Improve language: make short and simpler sentences, improve clarity
• Harmoniz

We have a workflow where we want do generate the release notes only from pull requests and mention the pull request author. I have found no way to do this yet...

I am not sure if this belongs here, but I am having an issue when using this Github Action.

This is the link to the github run that failed:
https://github.com/jampp/migratron/pull/25/checks?check_run_id=456554120

and the content is:

Uploading distributions to https://test.pypi.org/legacy/
Uploading migratron-1.1.0-py3-none-any.whl

  0%|          | 0.00/30.5k [00:00<?, ?B/s]
100%|

When "org.shipkit.javadoc" plugin is applied, then release notes should contain a link (as a badge) to the published Javadoc.

By default, the link should point to the specified directory ("javadoc.repositoryDirectory") and branch "javadoc.repositoryBranch" (see ShipkitConfiguration.java for more configuration options).

There should be also a possibility to point to some class, e.g. for Mock