Skip to content

fix missing plugin mentioning of spotbugs and spotless in CONTRIBUTING.md#10971

Closed
Pankraz76 wants to merge 1 commit intojenkinsci:masterfrom
Pankraz76:rw-fix-contri
Closed

fix missing plugin mentioning of spotbugs and spotless in CONTRIBUTING.md#10971
Pankraz76 wants to merge 1 commit intojenkinsci:masterfrom
Pankraz76:rw-fix-contri

Conversation

@Pankraz76
Copy link

See JENKINS-XXXXX.

Testing done

Proposed changelog entries

  • human-readable text

Proposed changelog category

/label

Proposed upgrade guidelines

N/A

Submitter checklist

  • The Jira issue, if it exists, is well-described.
  • The changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developers, depending on the change) and are in the imperative mood (see examples). Fill in the Proposed upgrade guidelines section only if there are breaking changes or changes that may require extra steps from users during upgrade.
  • There is automated testing or an explanation as to why this change has no tests.
  • New public classes, fields, and methods are annotated with @Restricted or have @since TODO Javadocs, as appropriate.
  • New deprecations are annotated with @Deprecated(since = "TODO") or @Deprecated(forRemoval = true, since = "TODO"), if applicable.
  • New or substantially changed JavaScript is not defined inline and does not call eval to ease future introduction of Content Security Policy (CSP) directives (see documentation).
  • For dependency updates, there are links to external changelogs and, if possible, full differentials.
  • For new APIs and extension points, there is a link to at least one consumer.

Desired reviewers

@mention

Before the changes are marked as ready-for-merge:

Maintainer checklist

  • There are at least two (2) approvals for the pull request and no outstanding requests for change.
  • Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.
  • Changelog entries in the pull request title and/or Proposed changelog entries are accurate, human-readable, and in the imperative mood.
  • Proper changelog labels are set so that the changelog can be generated automatically.
  • If the change needs additional upgrade steps from users, the upgrade-guide-needed label is set and there is a Proposed upgrade guidelines section in the pull request title (see example).
  • If it would make sense to backport the change to LTS, a Jira issue must exist, be a Bug or Improvement, and be labeled as lts-candidate to be considered (see query).

```

To fix frontend issues, after [optionally adding Node and Yarn to your path](#running-the-yarn-frontend-build), run:
To automatically fix frontend issues, run:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link to adding Node and Yarn was intentionally added for the benefit of developers like me that mostly work in backend code. I don't have Node and Yarn in my path usually and the link helps me find the extra steps that I need to use on those rare times when I need to run yarn lint:fix

More discussion of the reason for that phrasing is in:

Suggested change
To automatically fix frontend issues, run:
To fix frontend issues, after [optionally adding Node and Yarn to your path](#running-the-yarn-frontend-build), run:

@NotMyFault NotMyFault added the proposed-for-close There is no consensus about feasibility of this PR, and maintainers do not see a way forward for it label Aug 14, 2025
@NotMyFault
Copy link
Member

Agreed with Mark, this should rather stay as is

@NotMyFault NotMyFault added skip-changelog Should not be shown in the changelog and removed proposed-for-close There is no consensus about feasibility of this PR, and maintainers do not see a way forward for it labels Aug 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip-changelog Should not be shown in the changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants