Skip to content

Commit f19ec43

Browse files
committed
Add issue template and pull request template.
1 parent 55a4a7c commit f19ec43

File tree

6 files changed

+118
-1
lines changed

6 files changed

+118
-1
lines changed
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Bug Report
2+
description: Create a report to help us improve.
3+
labels: "bug"
4+
5+
body:
6+
7+
- type: markdown
8+
attributes:
9+
value: |
10+
## Notice
11+
12+
1. Please follow the [Code of Conduct](https://github.com/bytedance/bhook/blob/master/CODE_OF_CONDUCT.md) that this project adheres to.
13+
2. Please test using [the latest release](https://github.com/bytedance/bhook/releases) to make sure your issue has not already been fixed.
14+
3. Before submitting a bug, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/bytedance/bhook/issues?q=is%3Aissue+sort%3Acreated-desc+).
15+
16+
- type: input
17+
attributes:
18+
label: bytehook Version
19+
placeholder: "1.0.0"
20+
validations:
21+
required: true
22+
23+
- type: input
24+
attributes:
25+
label: Android OS Version
26+
placeholder: "10.0"
27+
validations:
28+
required: true
29+
30+
- type: dropdown
31+
attributes:
32+
label: Android ABIs
33+
multiple: true
34+
options:
35+
- armeabi-v7a
36+
- arm64-v8a
37+
validations:
38+
required: true
39+
40+
- type: input
41+
attributes:
42+
label: Device Manufacturers and Models
43+
placeholder: "Google Pixel 6 Pro, Samsung Galaxy S22 Ultra, ..."
44+
validations:
45+
required: true
46+
47+
- type: textarea
48+
attributes:
49+
label: Describe the Bug
50+
description: |
51+
Please provide a clear and concise description of what the bug is.
52+
53+
If relevant, add a minimal example so that we can reproduce the error by running the code. It is very important for the code snippet to be as succinct (minimal) as possible, so please take time to trim down any irrelevant code to help us debug efficiently. We are going to copy-paste your code and we expect to get the same result as you did.
54+
55+
If you observe an error, please paste the **full** error message you got. In case of a native crash, please paste the **full** tombstone in the `/data/tombstones` directory. For non-rooted devices, refer to [bugreport](https://developer.android.com/studio/debug/bug-report).
56+
validations:
57+
required: true
58+
59+
- type: markdown
60+
attributes:
61+
value: >
62+
Thanks for contributing! :tada:

.github/ISSUE_TEMPLATE/config.yml

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: Questions, Help and Discussions
4+
url: https://github.com/bytedance/bhook/discussions
5+
about: Looking for help and discuss general questions.
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Feature Request
2+
description: Submit a proposal/request for a new feature.
3+
labels: "enhancement"
4+
5+
body:
6+
7+
- type: markdown
8+
attributes:
9+
value: |
10+
## Notice
11+
12+
1. Please follow the [Code of Conduct](https://github.com/bytedance/bhook/blob/master/CODE_OF_CONDUCT.md) that this project adheres to.
13+
2. Please check [the latest release](https://github.com/bytedance/bhook/releases) to make sure your proposal has not already exists.
14+
3. Before submitting a feature request, please make sure the proposal hasn't been already addressed by searching through [the existing and past issues](https://github.com/bytedance/bhook/issues?q=is%3Aissue+sort%3Acreated-desc+).
15+
16+
- type: textarea
17+
attributes:
18+
label: the Feature, Motivation and Pitch
19+
description: >
20+
A clear and concise description of the feature proposal. Please outline the motivation for the proposal. Is your feature request related to a specific problem? If this is related to another GitHub issue, please link here too.
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
attributes:
26+
label: Alternatives
27+
description: >
28+
A description of any alternative solutions or features you've considered, if any.
29+
30+
- type: textarea
31+
attributes:
32+
label: Additional context
33+
description: >
34+
Add any other context about the feature request.
35+
36+
- type: markdown
37+
attributes:
38+
value: >
39+
Thanks for contributing! :tada:

.github/pull_request_template.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<!-- Thank you for submitting a Pull Request. Please:
2+
* Read our Pull Request guidelines:
3+
https://github.com/bytedance/bhook/blob/master/CONTRIBUTING.md
4+
* Associate an issue with the Pull Request.
5+
* Ensure that the code is up-to-date with the `main` branch.
6+
* Include a description of the proposed changes and how to test them.
7+
-->
8+
9+
This PR fixes #

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ There are 2 main branches:
2828

2929
## Pull Requests
3030

31+
**If possible, always create an issue first where you can describe your problem or feature request. We can also communicate in this issue. Then you can link to that issue in the pull request.**
32+
3133
Please make sure the following is done when submitting a pull request:
3234

3335
1. Fork the repo and create your branch from `main`.

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ The bytehook team and community take security bugs in bytehook seriously. We app
44

55
**Please do not report security vulnerabilities through GitHub issues, discussions or pull requests. This makes the problem immediately visible to everyone, including malicious actors.**
66

7-
Instead, please send email to <[email protected]>. If possible, encrypt your message with this [PGP key](https://raw.githubusercontent.com/caikelun/caikelun.github.io/master/site/pgp-public-key.txt).
7+
Instead, please send email to <[email protected]>. If possible, encrypt your message with [this PGP key](https://raw.githubusercontent.com/caikelun/caikelun.github.io/master/site/pgp-public-key.txt).
88

99
The bytehook team will send a response indicating the next steps in handling your report. After the initial reply to your report, the security team will keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance.

0 commit comments

Comments
 (0)