Skip to content

Commit

Permalink
Revise Issue Template, Etc.
Browse files Browse the repository at this point in the history
* Fix PR Template.
  • Loading branch information
garyrussell committed Feb 16, 2022
1 parent ea9601e commit bf30d5c
Show file tree
Hide file tree
Showing 8 changed files with 91 additions and 32 deletions.
23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: 'type: bug, status: waiting-for-triage'
assignees: ''

---

**In what version(s) of Spring for Apache Kafka are you seeing this issue?**

For example:

2.8.2

Between 2.7.0 and 2.8.2

**Describe the bug**

A clear and concise description of what the bug is.
Do not create an issue to ask a question; see below.

**To Reproduce**

Steps to reproduce the behavior.

**Expected behavior**

A clear and concise description of what you expected to happen.

**Sample**

A link to a GitHub repository with a [minimal, reproducible, sample](https://stackoverflow.com/help/minimal-reproducible-example).

Reports that include a sample will take priority over reports that do not.
At times, we may require a sample, so it is good to try and include a sample up front.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Community Support
url: https://stackoverflow.com/questions/tagged/spring-kafka
about: Please ask and answer questions on StackOverflow with the tag spring-kafka, or use the Discussions tab above.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: 'status: waiting-for-triage, type: enhancement'
assignees: ''

---

**Expected Behavior**

<!--- Tell us how it should work -->

**Current Behavior**

<!--- Explain the difference from current behavior -->

**Context**

<!---
How has this issue affected you?
What are you trying to accomplish?
What other alternatives have you considered?
Are you aware of any workarounds?
-->
7 changes: 7 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<!--
Thanks for contributing to Spring for Apache Kafka.
Please provide a brief description of your pull-request and reference any related issue numbers (prefix references with #) or StackOverflow questions.
See the [Contributor Guidelines for more information](https://github.com/spring-projects/spring-kafka/blob/main/CONTRIBUTING.adoc).
In particular, ensure the first line of the first commit comment is limited to 50 characters.
-->
File renamed without changes.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@ Spring for Apache Kafka [<img src="https://build.spring.io/plugins/servlet/witti
[![Join the chat at https://gitter.im/spring-projects/spring-kafka](https://badges.gitter.im/spring-projects/spring-kafka.svg)](https://gitter.im/spring-projects/spring-kafka?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
==================

# Code of Conduct

Please see our [Code of conduct](https://github.com/spring-projects/.github/blob/master/CODE_OF_CONDUCT.md).

# Reporting Security Vulnerabilities

Please see our [Security policy](https://github.com/spring-projects/spring-kafka/security/policy).

# Checking out and Building

To check out the project and build from source, do the following:
Expand Down Expand Up @@ -83,10 +91,4 @@ None of these is essential for a pull request, but they will all help.

# License

Spring Kafka is released under the terms of the Apache Software License Version 2.0 (see license.txt).

# Code of Conduct

This project adheres to the Contributor Covenant [code of conduct](./CODE_OF_CONDUCT.adoc).
By participating, you are expected to uphold this code. Please report unacceptable behavior to
spring-code-of-conduct@pivotal.io.
Spring Kafka is released under the terms of the Apache Software License Version 2.0 (see LICENSE.txt).
11 changes: 9 additions & 2 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -289,11 +289,14 @@ subprojects { subproject ->
}

from("${rootProject.projectDir}/src/dist") {
include 'license.txt'
include 'notice.txt'
into 'META-INF'
expand(copyright: new Date().format('yyyy'), version: project.version)
}
from("${rootProject.projectDir}") {
include 'LICENSE.txt'
into 'META-INF'
}
}

tasks.withType(Javadoc) {
Expand Down Expand Up @@ -552,11 +555,15 @@ task distZip(type: Zip, dependsOn: [docsZip]) { //, schemaZip]) {

from('src/dist') {
include 'readme.txt'
include 'license.txt'
include 'notice.txt'
into "${baseDir}"
}

from("$project.rootDir") {
include 'LICENSE.txt'
into "${baseDir}"
}

from(zipTree(docsZip.archivePath)) {
into "${baseDir}/docs"
}
Expand Down

0 comments on commit bf30d5c

Please sign in to comment.