diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..926b6a7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,62 @@ +name: Bug Report +description: Create a report to help us improve. +labels: "bug" + +body: + + - type: markdown + attributes: + value: | + ## Notice + + 1. Please follow the [Code of Conduct](https://github.com/bytedance/bhook/blob/master/CODE_OF_CONDUCT.md) that this project adheres to. + 2. Please test using [the latest release](https://github.com/bytedance/bhook/releases) to make sure your issue has not already been fixed. + 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+). + + - type: input + attributes: + label: bytehook Version + placeholder: "1.0.0" + validations: + required: true + + - type: input + attributes: + label: Android OS Version + placeholder: "10.0" + validations: + required: true + + - type: dropdown + attributes: + label: Android ABIs + multiple: true + options: + - armeabi-v7a + - arm64-v8a + validations: + required: true + + - type: input + attributes: + label: Device Manufacturers and Models + placeholder: "Google Pixel 6 Pro, Samsung Galaxy S22 Ultra, ..." + validations: + required: true + + - type: textarea + attributes: + label: Describe the Bug + description: | + Please provide a clear and concise description of what the bug is. + + 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. + + 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). + validations: + required: true + + - type: markdown + attributes: + value: > + Thanks for contributing! :tada: diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..81dbf8e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Questions, Help and Discussions + url: https://github.com/bytedance/bhook/discussions + about: Looking for help and discuss general questions. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..679d323 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,39 @@ +name: Feature Request +description: Submit a proposal/request for a new feature. +labels: "enhancement" + +body: + + - type: markdown + attributes: + value: | + ## Notice + + 1. Please follow the [Code of Conduct](https://github.com/bytedance/bhook/blob/master/CODE_OF_CONDUCT.md) that this project adheres to. + 2. Please check [the latest release](https://github.com/bytedance/bhook/releases) to make sure your proposal has not already exists. + 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+). + + - type: textarea + attributes: + label: the Feature, Motivation and Pitch + description: > + 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. + validations: + required: true + + - type: textarea + attributes: + label: Alternatives + description: > + A description of any alternative solutions or features you've considered, if any. + + - type: textarea + attributes: + label: Additional context + description: > + Add any other context about the feature request. + + - type: markdown + attributes: + value: > + Thanks for contributing! :tada: diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..9308037 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,9 @@ + + +This PR fixes # diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 87f0264..069f946 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,6 +28,8 @@ There are 2 main branches: ## Pull Requests +**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.** + Please make sure the following is done when submitting a pull request: 1. Fork the repo and create your branch from `main`. diff --git a/SECURITY.md b/SECURITY.md index 391ce07..15d21b7 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -4,6 +4,6 @@ The bytehook team and community take security bugs in bytehook seriously. We app **Please do not report security vulnerabilities through GitHub issues, discussions or pull requests. This makes the problem immediately visible to everyone, including malicious actors.** -Instead, please send email to . If possible, encrypt your message with this [PGP key](https://raw.githubusercontent.com/caikelun/caikelun.github.io/master/site/pgp-public-key.txt). +Instead, please send email to . If possible, encrypt your message with [this PGP key](https://raw.githubusercontent.com/caikelun/caikelun.github.io/master/site/pgp-public-key.txt). 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.