Topics

How-To Guides

Resources

Extensions Index
Javadoc
Taglibs
Tools

Report an Issue

The plugins site https://plugins.jenkins.io includes a “Report an Issue” link for each of the plugins. The linked page guides the user to provide a better classified issue and leads them to the correct path to privately report security issues.

Create a branch

Create a git branch for your local work with the command:

$ git checkout -b report-an-issue-link master

Add "Report an Issue" to README

Add a heading in the plugin documentation that links to the specific “Report an Issue” link provided by the https://plugins.jenkins.io site. Some plugins use GitHub issues. The link from the https://plugins.jenkins.io site is the correct link to use in that case as well.

For example, the link for the git plugin is https://www.jenkins.io/participate/report-issue/redirect/#15543, while the link for the elastic axis plugin is https://www.jenkins.io/participate/report-issue/redirect/#17588.

diff --git a/README.md b/README.md
index 41fad51..e4bc674 100644
--- a/README.md
+++ b/README.md

+## Report an Issue
+
+Please report issues and enhancements through the
+[Jenkins issue tracker](https://www.jenkins.io/participate/report-issue/redirect/#19326).
+

Create a pull request

Commit that change:

$ git add README.md
$ git commit -m "Report an Issue"

Push the change to GitHub:

$ git push origin --set-upstream report-an-issue-link
Total 0 (delta 0), reused 0 (delta 0), pack-reused 0
remote:
remote: Create a pull request for 'report-an-issue-link' on GitHub by visiting:
remote: https://github.com/user/your-plugin/pull/new/report-an-issue-link
remote:
To github.com:user/your-plugin.git
 * [new branch]      report-an-issue-link -> report-an-issue-link
Branch 'report-an-issue-link' tracking remote branch 'report-an-issue-link'.

Notice that the output of the command includes the URL, which can be used to open a pull request. Copy that URL in your web browser and submit a pull request.