Skip to content

Commit 4c03abc

Browse files
authoredMay 20, 2018
Added issue and PR templates (#62)
* Added issue and PR templates * Removed unnecessary lines * Updated README
1 parent 7f16d4b commit 4c03abc

File tree

3 files changed

+73
-16
lines changed

3 files changed

+73
-16
lines changed
 

‎.github/ISSUE_TEMPLATE.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
[download]: https://bintray.com/jagrosh/maven/JDA-Utilities/_latestVersion
2+
[guild]: https://discord.gg/0hMr4ce0tIk3pSjp
3+
[stack overflow]: https://stackoverflow.com/questions/tagged/java
4+
[issues]: https://github.com/JDA-Applications/JDA-Utilities/issues
5+
[jda-issues]: https://github.com/DV8FromTheWorld/JDA/issues
6+
[examples-module]: https://github.com/JDA-Applications/JDA-Utilities/tree/master/examples
7+
[jda-u-projects]: https://github.com/JDA-Applications/JDA-Utilities#projects
8+
9+
## Issue
10+
11+
#### Issue Checklist
12+
Please follow the following steps before opening this issue.<br>
13+
Issues that do not complete the checklist may be closed without any help.
14+
15+
- [ ] I have checked for similar issues on the [issue tracker][issues].
16+
- [ ] I have updated to the [latest version][download] of JDA-Utilities.
17+
- [ ] I have checked the branches or the maintainers' PRs for upcoming features/bug fixes.
18+
19+
> The issue tracker is reserved for issues, errors, and feature requests related
20+
> to JDA-Utilities, and not questions and other requests for help.
21+
>
22+
> - For examples, check out the [examples module][examples-module] or the list
23+
> of [JDA-Utilities projects][jda-u-projects].
24+
> - For questions join the [official JDA discord server][guild] and ask them
25+
> in our `#jda-utilities` channel.
26+
> - For general programming questions, visit [StackOverflow][stack overflow].
27+
28+
#### Issue Information
29+
Check all that apply:
30+
31+
- [ ] This is a bug report about an error, issue, or bug in JDA-Utilities.
32+
- [ ] I have been able to consistently reproduce this bug.
33+
- [ ] This is a feature request for the JDA-Utilities library.
34+
35+
> This issue tracker **does not** assist or handle issues with the JDA library.<br>
36+
> For JDA related issues, visit the [JDA issue tracker][jda-issues]
37+
> and open an issue there.
38+
39+
#### Description
40+
41+
Describe your issue here.<br>
42+
Please provide any stack-traces, code, or pictures that will help describe the issue you are encountering.

‎.github/PULL_REQUEST_TEMPLATE.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
[contributing]: https://github.com/DV8FromTheWorld/JDA/wiki/5%29-Contributing
2+
[pull-request]: https://github.com/JDA-Applications/JDA-Utilities/pulls
3+
4+
## Pull Request
5+
6+
#### Pull Request Checklist
7+
Please follow the following steps before opening this PR.<br>
8+
PRs that do not complete the checklist will be subject to denial for
9+
missing information.
10+
11+
- [ ] I have checked the [pull request page][pull-request] for upcoming
12+
or merged features/bug fixes.
13+
- [ ] I have read JDA's [contributing guidelines][contributing].
14+
15+
#### Pull Request Information
16+
Check and fill in the blanks for all that apply:
17+
18+
- [ ] My PR fixes a bug, error, or other issue with the library's codebase.
19+
- [ ] My PR is for the `______` module of the JDA-Utilities library.
20+
- [ ] My PR creates a new module for the JDA-Utilities library: `______`.
21+
22+
#### Description
23+
24+
Describe your PR here.

‎README.md

+7-16
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,19 @@
22
[download]: https://bintray.com/jagrosh/maven/JDA-Utilities/_latestVersion
33
[license]: https://img.shields.io/badge/License-Apache%202.0-lightgrey.svg
44
[issues]: https://img.shields.io/github/issues/JDA-Applications/JDA-Utilities.svg
5-
[issueslink]: https://github.com/JDA-Applications/JDA-Utilities/issues
5+
[issues-link]: https://github.com/JDA-Applications/JDA-Utilities/issues
66

77
[ ![version][] ][download]
88
[ ![license][] ](https://github.com/JDA-Applications/JDA-Utilities/tree/master/LICENSE)
9-
[ ![issues][] ][issueslink]
9+
[ ![issues][] ][issues-link]
1010

1111
## JDA-Utilities
1212
JDA-Utilities is a series of tools and utilities for use with [JDA](https://github.com/DV8FromTheWorld/JDA)
1313
to assist in bot creation.
1414

15-
## Version 2.0 Notice
16-
Version 2.0 comes with a lot of big (some breaking) changes to the library.
17-
18-
If you use this library for anything, it is **STRONGLY** recommended you read
19-
[this gist](https://gist.github.com/TheMonitorLizard/4f09ac2a3c9d8019dc3cde02cc456eee)
20-
which documents all of the changes that have been made.
21-
22-
If you have questions or concerns about any of these changes, please contact **Shengaero**#9090.
23-
2415
## Packages
2516

26-
Since JDA-Utilities 2.0, the library has been split into multiple modular projects,
17+
Since JDA-Utilities 2.x, the library has been split into multiple modular projects,
2718
in order to better organize it's contents based on what developers might want to use and not use.
2819

2920
+ [Command Package](https://github.com/JDA-Applications/JDA-Utilities/tree/master/command)
@@ -43,7 +34,7 @@ With maven:
4334
<dependency>
4435
<groupId>com.jagrosh</groupId>
4536
<artifactId>jda-utilities</artifactId>
46-
<version>2.1</version>
37+
<version>JDA-UTILITIES-VERSION</version>
4738
<scope>compile</scope>
4839
<type>pom</type>
4940
</dependency>
@@ -64,7 +55,7 @@ With maven:
6455
With gradle:
6556
```groovy
6657
dependencies {
67-
compile 'com.jagrosh:jda-utilities:2.1'
58+
compile 'com.jagrosh:jda-utilities:JDA-UTILITIES-VERSION'
6859
compile 'net.dv8tion:JDA:JDA-VERSION'
6960
}
7061
@@ -82,7 +73,7 @@ With maven:
8273
<groupId>com.jagrosh</groupId>
8374
<!-- Notice that the dependency notation ends with "-command" -->
8475
<artifactId>jda-utilities-command</artifactId>
85-
<version>2.1</version>
76+
<version>JDA-UTILITIES-VERSION</version>
8677
<scope>compile</scope>
8778
</dependency>
8879
```
@@ -91,7 +82,7 @@ With gradle:
9182
```groovy
9283
dependencies {
9384
// Notice that the dependency notation ends with "-command"
94-
compile 'com.jagrosh:jda-utilities-command:2.1'
85+
compile 'com.jagrosh:jda-utilities-command:JDA-UTILITIES-VERSION'
9586
}
9687
```
9788

0 commit comments

Comments
 (0)
Please sign in to comment.