Skip to content

Commit caed720

Browse files
zhu-xiaoweixiaoweii
zhu-xiaowei
and
xiaoweii
authored
chore: add github templates for issue and pr (#14)
1. add bug_report and feature_report template for issue. 2. add pr template. Close #6 --------- Co-authored-by: xiaoweii <xiaoweii@amazom.com>
1 parent 42dfd3f commit caed720

File tree

5 files changed

+272
-0
lines changed

5 files changed

+272
-0
lines changed

‎.github/ISSUE_TEMPLATE/1.bug_report.yaml‎

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
name: Bug report
2+
description: Create a report to help us improve Clickstream Android
3+
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this bug report! Try to include as much information as you can.
9+
- type: markdown
10+
attributes:
11+
value: |
12+
For reference, the current versions of the Clickstream Android packages are listed below. Please verify your issue against the latest version(s) of the relevant package(s).
13+
14+
| Package | Version |
15+
| ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------- |
16+
| `software.aws.solution:clickstream` | [![Maven Central](https://img.shields.io/maven-central/v/software.aws.solution/clickstream.svg)](https://search.maven.org/artifact/software.aws.solution/clickstream)|
17+
18+
- type: checkboxes
19+
attributes:
20+
label: |
21+
Before opening, please confirm:
22+
options:
23+
- label: I have [searched for duplicate or closed issues](https://github.com/awslabs/clickstream-android/issues?q=is%3Aissue+).
24+
required: true
25+
26+
- type: markdown
27+
attributes:
28+
value: |
29+
## Environment
30+
- type: dropdown
31+
attributes:
32+
label: Language and Async Model
33+
description: What programming language is being used?
34+
multiple: true
35+
options:
36+
- Java
37+
- Kotlin
38+
- Kotlin - Coroutines
39+
- RxJava
40+
- Not applicable
41+
validations:
42+
required: true
43+
- type: textarea
44+
attributes:
45+
label: Gradle script dependencies
46+
description: |
47+
Please provide the version of Clickstream being used from your `build.gradle (Module: app)` file.
48+
value: |
49+
<details>
50+
51+
```groovy
52+
// Put output below this line
53+
54+
55+
```
56+
57+
</details>
58+
validations:
59+
required: true
60+
- type: textarea
61+
attributes:
62+
label: Environment information
63+
description: |
64+
Please run the following command inside your project and copy/paste the output below:
65+
```
66+
./gradlew --version
67+
```
68+
value: |
69+
<details>
70+
71+
```
72+
# Put output below this line
73+
74+
75+
```
76+
77+
</details>
78+
validations:
79+
required: true
80+
- type: markdown
81+
attributes:
82+
value: |
83+
## Details
84+
- type: input
85+
attributes:
86+
label: Please include any relevant guides or documentation you're referencing
87+
- type: textarea
88+
attributes:
89+
label: Describe the bug
90+
description: A clear and concise description of what the bug is.
91+
validations:
92+
required: true
93+
- type: textarea
94+
attributes:
95+
label: Reproduction steps (if applicable)
96+
description: |
97+
How do you trigger this bug? Please walk us through it step by step. Screenshots can be attached in textarea below.
98+
placeholder: |
99+
1. Install '...'
100+
2. Configure '...'
101+
3. Go to '...'
102+
4. See error
103+
- type: textarea
104+
attributes:
105+
label: Code Snippet
106+
description: |
107+
Please provide a code snippet or a link to sample code of the issue you are experiencing to help us reproduce the issue.
108+
109+
**Be sure to remove any sensitive data.**
110+
value: |
111+
```java
112+
// Put your code below this line.
113+
114+
```
115+
- type: textarea
116+
attributes:
117+
label: Log output
118+
description: |
119+
For example, error messages, or stack traces.
120+
**Be sure to remove any sensitive data.**
121+
value: |
122+
<details>
123+
124+
```
125+
// Put your logs below this line
126+
127+
128+
```
129+
130+
</details>
131+
132+
- type: textarea
133+
attributes:
134+
label: Additional information and screenshots
135+
description: |
136+
If you have any additional information, workarounds, etc. for us, use the field below.
137+
Please note, you can attach screenshots or screen recordings here, by
138+
dragging and dropping files in the field below.

‎.github/ISSUE_TEMPLATE/2.feature_report.yaml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Feature request
2+
description: Create a feature request to help us improve Clickstream Android
3+
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this feature request! Try to include as much information as you can.
9+
- type: markdown
10+
attributes:
11+
value: |
12+
For reference, the current versions of the Clickstream Android are listed below. Please verify your issue against the latest version(s) of the relevant package(s).
13+
14+
| Package | Version |
15+
| ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------- |
16+
| `software.aws.solution:clickstream` | [![Maven Central](https://img.shields.io/maven-central/v/software.aws.solution/clickstream.svg)](https://search.maven.org/artifact/software.aws.solution/clickstream)|
17+
18+
- type: checkboxes
19+
attributes:
20+
label: |
21+
Before opening, please confirm:
22+
options:
23+
- label: I have [searched for duplicate or closed issues](https://github.com/awslabs/clickstream-android/issues?q=is%3Aissue+).
24+
required: true
25+
26+
- type: textarea
27+
id: description
28+
attributes:
29+
label: Is your feature request related to a problem? Please describe.
30+
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: proposal
36+
attributes:
37+
label: Describe the solution you'd like
38+
description: A clear and concise description of what you want to happen.
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: alternatives
44+
attributes:
45+
label: Describe alternatives you've considered
46+
description: A clear and concise description of any alternative solutions or features you've considered.
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
id: context
52+
attributes:
53+
label: Additional context
54+
description: Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/config.yaml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: GitHub Community Support
4+
url: https://github.com/awslabs/clickstream-android/discussions
5+
about: Please ask and answer questions here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
- [ ] PR title and description conform to [Pull Request](https://github.com/awslabs/clickstream-android/blob/main/CONTRIBUTING.md#pull-request-guidelines) guidelines.
2+
3+
*Issue #, if available:*
4+
5+
*Description of changes:*
6+
7+
*How did you test these changes?*
8+
(Please add a line here how the changes were tested)
9+
10+
*Documentation update required?*
11+
- [ ] No
12+
- [ ] Yes (Please include a PR link for the documentation update)
13+
14+
*General Checklist*
15+
- [ ] Added Unit Tests
16+
17+
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

‎CONTRIBUTING.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,64 @@ reported the issue. Please try to include as much information as you can. Detail
2121

2222

2323
## Contributing via Pull Requests
24+
25+
This is mostly the same as [GitHub's guide on creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
26+
27+
First, create a _fork_ of `clickstream-android`. Clone it, and make changes to this _fork_.
28+
29+
```shell
30+
git clone git@github.com:your_username/clickstream-android.git
31+
```
32+
33+
After you have tested your feature/fix, by adding sufficient test coverage, and
34+
validating Checkstyle, lint, and the existing test suites, you're ready to
35+
publish your change.
36+
37+
The commit message should look like below. It started with a prefix like feat/fix or
38+
chore. After a paragraph describing what you've done, include links to useful resources. These might
39+
include design documents, StackOverflow implementation notes, GitHub issues,
40+
etc. All links must be publicly accessible.
41+
42+
```console
43+
feat: add new preset event for screen view.
44+
45+
Resolves: https://github.com/awslabs/clickstream-android/issues/222
46+
See also: https://stackoverflow.com/a/58662077/695787
47+
```
48+
49+
Now, save your work to a new branch:
50+
51+
```shell
52+
git checkout -b feature_screen_view
53+
```
54+
55+
To publish it:
56+
57+
```shell
58+
git push -u origin feature_screen_view
59+
```
60+
61+
This last step will give you a URL to view a GitHub page in your browser.
62+
Copy-paste this, and complete the workflow in the UI. It will invite you to
63+
"create a PR" from your newly published branch.
64+
65+
### Pull Request Guidelines
66+
- The title of your PR must be descriptive to the specific change.
67+
- The title of your PR must be of below format since next release version is determined from PR titles in the commit history.
68+
- For a bugfix: `fix: description of changes`
69+
- For a feature: `feat: add awesome feature`
70+
- Everything else: `chore: fix build script`
71+
- No period at the end of the title.
72+
- Pull Request message should indicate which issues are fixed: `fixes #<issue>` or `closes #<issue>`.
73+
- If not obvious (i.e. from unit tests), describe how you verified that your change works.
74+
- If this PR includes breaking changes, they must be listed at the top of the changelog as described above in the Pull Request Checklist.
75+
- PR must be reviewed by at least one repository maintainer, in order
76+
to be considered for inclusion.
77+
- PR must also pass the Actions like Checkstyle, Lint, and Unit tests.
78+
- Usually all these are going to be **squashed** when you merge to main.
79+
- Make sure to update the PR title/description if things change.
80+
- Rebase with the `main` branch if it has commits ahead of your fork.
81+
2482
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
2583

2684
1. You are working against the latest source on the *main* branch.

0 commit comments

Comments
 (0)