Since the forward-moving source of this plugin is now a part of the
RabbitMQ Integration, provide users and contributors simple paths forward
for reporting issues and contributing patches.
This change is likely to be the prototype for at least the next several integration plugin projects, so I'm hoping for a little extra scrutiny.
The goal is to redirect users and contributors to the integration project as early as possible, and to provide support for moving forward with reporting issues or contributing fixes if they mistakenly end up here.
README.md: add a clear block at the top, pointing toward the integration project and defining the purpose of this stand-alone project still being open.
docs/index.asciidoc: since this file has been moved to docs/${type}-${name}.asciidoc in the integration project (which contains its own docs/index.asciidoc), a user attempting to contribute changes from the stand-alone project to this file is going to create a patch that doesn't apply cleanly. This header is meant to get them looking in the right direction before putting in work that will be tedious to resolve.
.github/ISSUE_TEMPLATE.md: when a user encounters this, typically they are in the process of opening an issue on the project (and likely already frustrated). By pointing them to the integration project and reiterating the purpose of the stand-alone project being open for backports, I hope to alleviate some pain.
.github/PULL_REQUEST_TEMPLATE.md: when a contributor encounters this, typically they have missed all of the other signs and invested significant effort into putting together their proposed changes. My goal with this document is to point them in the right direction and offer assurance of help moving forward to reduce their frustration.
_Note: even though the integration plugin contains the complete source history of this plugin and will be our Source of Truth moving forward, we are not closing the issue tracker here, nor do we plan to archive this stand-alone repository in the immediate future. Individual plugins cannot presently be built from the integrated source, so 6.x maintenance will live on here._
Since the forward-moving source of this plugin is now a part of the RabbitMQ Integration, provide users and contributors simple paths forward for reporting issues and contributing patches.
This change is likely to be the prototype for at least the next several integration plugin projects, so I'm hoping for a little extra scrutiny.
The goal is to redirect users and contributors to the integration project as early as possible, and to provide support for moving forward with reporting issues or contributing fixes if they mistakenly end up here.
README.md
: add a clear block at the top, pointing toward the integration project and defining the purpose of this stand-alone project still being open.docs/index.asciidoc
: since this file has been moved todocs/${type}-${name}.asciidoc
in the integration project (which contains its owndocs/index.asciidoc
), a user attempting to contribute changes from the stand-alone project to this file is going to create a patch that doesn't apply cleanly. This header is meant to get them looking in the right direction before putting in work that will be tedious to resolve..github/ISSUE_TEMPLATE.md
: when a user encounters this, typically they are in the process of opening an issue on the project (and likely already frustrated). By pointing them to the integration project and reiterating the purpose of the stand-alone project being open for backports, I hope to alleviate some pain..github/PULL_REQUEST_TEMPLATE.md
: when a contributor encounters this, typically they have missed all of the other signs and invested significant effort into putting together their proposed changes. My goal with this document is to point them in the right direction and offer assurance of help moving forward to reduce their frustration._Note: even though the integration plugin contains the complete source history of this plugin and will be our Source of Truth moving forward, we are not closing the issue tracker here, nor do we plan to archive this stand-alone repository in the immediate future. Individual plugins cannot presently be built from the integrated source, so 6.x maintenance will live on here._