Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move MAINTAINERS.adoc at the root folder #7528

Merged

Conversation

lemeurherve
Copy link
Member

@lemeurherve lemeurherve commented Dec 15, 2022

Follow-up of my first (misplaced) suggestions on the "Disambiguate and document the closure process" pull request: #7516 (comment)

This PR moves the /docs/ unique document at the root folder of this repository because having this file in /docs/ is inconsistent with other documentation and it would make more sense at the root folder of the repository.

It depends on #7527 which converts the two existing Markdown documents to Asciidoc.

Testing done

N/A

Proposed changelog entries

N/A

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

@basil

Maintainer checklist

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

  • 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).

Copy link
Member

@basil basil left a comment

Choose a reason for hiding this comment

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

Thanks Hervé, this has long been an annoyance.

@lemeurherve lemeurherve marked this pull request as draft December 16, 2022 00:03
@lemeurherve lemeurherve marked this pull request as ready for review December 16, 2022 00:05
@NotMyFault NotMyFault added the skip-changelog Should not be shown in the changelog label Dec 16, 2022
Copy link
Member

@NotMyFault NotMyFault left a comment

Choose a reason for hiding this comment

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

Oh, I sense a sane document structure, nice!

@github-actions
Copy link
Contributor

Please take a moment and address the merge conflicts of your pull request. Thanks!

@github-actions github-actions bot added the unresolved-merge-conflict There is a merge conflict with the target branch. label Dec 17, 2022
@github-actions github-actions bot removed the unresolved-merge-conflict There is a merge conflict with the target branch. label Dec 17, 2022
@basil basil merged commit 43e4efb into jenkinsci:master Dec 17, 2022
NotMyFault added a commit to NotMyFault/jenkins that referenced this pull request Dec 17, 2022
NotMyFault added a commit that referenced this pull request Dec 17, 2022
* Revert "Move `MAINTAINERS` to the root folder (#7528)"

This reverts commit 43e4efb.

* Revert "Convert `README` and `CONTRIBUTING` from Markdown to AsciiDoc (#7527)"

This reverts commit 48edf2c.
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.

6 participants