[Docs] Doc additions for:

* Issue template
* Pull request template
* Add stackoverflow links
* Add getting help section
This commit is contained in:
Chris Bono
2022-12-16 11:24:27 -06:00
committed by Soby Chacko
parent 481e2d86f9
commit 5686a1980c
6 changed files with 79 additions and 4 deletions

27
.github/ISSUE_TEMPLATE.md vendored Normal file
View File

@@ -0,0 +1,27 @@
<!--
Thanks for raising a Spring for Apache Pulsar issue. Please take the time to review the following
categories as some of them do not apply here.
🙅 "Please DO NOT Raise an Issue" Cases
- Question
STOP!! Please ask questions about how to use something, or to understand why something isn't
working as you expect it to, on Stack Overflow using the spring-pulsar tag.
- Security Vulnerability
STOP!! Please don't raise security vulnerabilities here. Head over to https://spring.io/security-policy to learn how to disclose them responsibly.
- With an Immediate Pull Request
An issue will be closed as a duplicate of the immediate pull request, so you don't have to raise an issue if you plan to create a pull request immediately.
🐞 Bug report (please don't include this emoji/text, just add your details)
Please provide details of the problem, including the version of Spring for Apache Pulsar that you
are using. If possible, please provide a test case or sample application that reproduces
the problem. This makes it much easier for us to diagnose the problem and to verify that
we have fixed it.
🎁 Enhancement (please don't include this emoji/text, just add your details)
Please start by describing the problem that you are trying to solve. There may already
be a solution, or there may be a way to solve it that you hadn't considered.
TIP: You can always edit your issue if it isn't formatted correctly.
See https://guides.github.com/features/mastering-markdown
-->

31
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@@ -0,0 +1,31 @@
<!--
Thanks for contributing to Spring for Apache Pulsar. Please review the following notes before
submitting a pull request.
Please submit only genuine pull-requests. Do not use this repository as a GitHub
playground.
Security Vulnerabilities
STOP! If your contribution fixes a security vulnerability, please do not submit it.
Instead, please head over to https://spring.io/security-policy to learn how to disclose a
vulnerability responsibly.
Dependency Upgrades
Please do not open a pull request for a dependency upgrade. The team prefers to handles these internally. However, if a fix or feature requires an upgrade of a library go ahead and submit the upgrade with the code proposal and the review process will determine if it is accepted.
CI / Build Changes
Please do not open a pull request for a CI or build changes. The team prefers to handles these internally. Instead, open an issue to report any problems or improvements in this area.
Describing Your Changes
If, having reviewed the notes above, you're ready to submit your pull request, please
provide a brief description of the proposed changes. If they fix a bug, please
describe the broken behaviour and how the changes fix it. If they make an enhancement,
please describe the new functionality and why you believe it's useful. If your pull
request relates to any existing issues, please reference them by using the issue number
prefixed with #.
-->

View File

@@ -14,9 +14,8 @@ By participating, you are expected to uphold this code. Please report unacceptab
== Using GitHub Issues
We use GitHub issues to track bugs and enhancements.
// NYI
// If you have a general usage question please ask on https://stackoverflow.com[Stack Overflow].
// The Spring Pulsar team and the broader community monitor the https://stackoverflow.com/tags/spring-pulsar[`spring-pulsar`] tag.
If you have a general usage question please ask on https://stackoverflow.com[Stack Overflow].
The Spring for Apache Pulsar team and the broader community monitor the https://stackoverflow.com/tags/spring-pulsar[`spring-pulsar`] tag.
If you are reporting a bug, please help to speed up problem diagnosis by providing as much information as possible.
Ideally, that would include a small sample project that reproduces the problem.

View File

@@ -18,7 +18,7 @@ Are you having trouble with Spring Pulsar? We want to help!
* Learn the Spring basics -- Spring Pulsar builds on many other Spring projects; check the https://spring.io[spring.io] website for a wealth of reference documentation.
If you are new to Spring, try one of the https://spring.io/guides[guides].
// TODO (NYI): * If you are upgrading, read the {github}/wiki[release notes] for upgrade instructions and "new and noteworthy" features.
// TODO (NYI): * Ask a question -- we monitor https://stackoverflow.com[stackoverflow.com] for questions tagged with https://stackoverflow.com/tags/spring-pulsar[`spring-pulsar`].
* Ask a question -- we monitor https://stackoverflow.com[stackoverflow.com] for questions tagged with https://stackoverflow.com/tags/spring-pulsar[`spring-pulsar`].
* Report bugs with Spring Pulsar at {github}/issues[github.com/spring-projects-experimental/spring-pulsar/issues].

View File

@@ -0,0 +1,16 @@
[[getting-help]]
= Getting Help
include::attributes.adoc[]
If you have trouble with Spring for Apache Pulsar, we would like to help.
* Learn the Spring basics.
Spring for Apache Pulsar builds on several other Spring projects.
Check the https://spring.io[spring.io] web-site for a wealth of reference documentation.
If you are starting out with Spring, try one of the https://spring.io/guides[guides].
* Ask a question.
We monitor https://stackoverflow.com[stackoverflow.com] for questions tagged with https://stackoverflow.com/tags/spring-pulsar[`spring-pulsar`].
* Report bugs at {github}/issues.
NOTE: All of Spring for Apache Pulsar is open source, including the documentation.
If you find problems with the docs or if you want to improve them, please get involved.

View File

@@ -9,6 +9,8 @@ include::copyright.adoc[]
include::intro.adoc[leveloffset=+1]
include::getting-help.adoc[leveloffset=+2]
[[reference]]
== Reference
This part of the reference documentation goes through the details of the various components in Spring for Apache Pulsar.