diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 68877de..b78e4b8 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,14 +7,34 @@ assignees: '' --- -**Describe the bug** -Use `./hack-browser-data -vv` paste result here +## Describe the bug +A clear and concise description of what the bug is. +## Log Output +Please attach or paste the relevant log output. Use `./hack-browser-data -vv` and paste result here. -**Desktop (please complete the following information):** - - OS Name: - - Browser Name: - - Browser Version: +## Expected vs Actual Behavior +Describe what you expected to happen and what actually happened. -**Additional context** -Add any other context about the problem here. +## Desktop (please complete the following information): +Select the operating system(s) you are using: +- [ ] Windows +- [ ] macOS +- [ ] Linux + +- OS Version: [e.g. windows 10, macos 10.15.7, ubuntu 20.04] +- OS Architecture: [e.g. 32-bit, 64-bit] +- Browser Name: [e.g. chrome, firefox] +- Browser Version: [e.g. 86.0.4240.111, 82.0.3] + +## Additional Details +- [ ] I ran `hack-browser-data` with administrator/root privileges. + +## Checklist +- [ ] I have checked the [existing issues](https://github.com/moonD4rk/HackBrowserData/issues) for similar problems. + +## Screenshots/Videos +If applicable, add screenshots or videos to help explain your problem. + +## Additional context +Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..f56e15c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,23 @@ +--- +name: Feature Request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + +## Feature Description +A clear and concise description of what the feature is. + +## Why is this feature needed? +A clear and concise description of why this feature is needed. + +## Checklist +- [ ] I have checked the [existing issues](https://github.com/moonD4rk/HackBrowserData/issues) for similar problems. + +## Screenshots/Videos +If applicable, add screenshots or videos to help explain your proposal. + +## Additional Context +Add any other context or screenshots about the feature request here. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..48134b9 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,13 @@ +## Proposed changes + + + + +## Checklist + + + +- [ ] Pull request is created against the [dev](https://github.com/moonD4rk/HackBrowserData/tree/dev) branch +- [ ] All checks passed (lint, unit, build tests etc.) with my changes +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] I have added necessary documentation (if appropriate) \ No newline at end of file diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 8791aa2..2eef248 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -5,6 +5,7 @@ on: branches: - main pull_request: + workflow_dispatch: jobs: build: diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index c1a8af0..f9e0a0a 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -4,6 +4,7 @@ on: branches: - main pull_request: + workflow_dispatch: jobs: lint: name: Lint diff --git a/.github/workflows/unittest.yml b/.github/workflows/unittest.yml index 5411269..4c603f3 100644 --- a/.github/workflows/unittest.yml +++ b/.github/workflows/unittest.yml @@ -1,5 +1,9 @@ on: - [pull_request] + pull_request: + push: + branches: + - main + workflow_dispatch: name: run tests jobs: diff --git a/.gitignore b/.gitignore index ad208e1..f2148f6 100644 --- a/.gitignore +++ b/.gitignore @@ -196,4 +196,9 @@ hack-browser-data !/browsingdata/history/history_test.go # github action -!/.github/workflows/unittest.yml \ No newline at end of file +!/.github/workflows/unittest.yml +!/.github/ISSUE_TEMPLATE/*.md +!/.github/*.md + +# Community +!CONTRIBUTING.md \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3f627b0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing to HackBrowserData + +We appreciate your interest in contributing to the HackBrowserData! This document provides some basic guidelines for contributors. + +## Getting Started + +- Always base your work from the `dev` branch, which is the development branch with the latest code. +- Before creating a Pull Request (PR), make sure there is a corresponding issue for your contribution. If there isn't one already, please create one. +- Include the problem description in the issue. + +## Pull Requests + +When creating a PR, please follow these guidelines: + +- Link your PR to the corresponding issue. +- Provide context in the PR description to help reviewers understand the changes. The more information you provide, the faster the review process will be. +- Include an example of running the tool with the changed code, if applicable. Provide 'before' and 'after' examples if possible. +- Include steps for functional testing or replication. +- If you're adding a new feature, make sure to include unit tests. + +## Code Style + +Please adhere to the existing coding style for consistency. + +## Questions + +If you have any questions or need further guidance, please feel free to ask in the issue or PR, or [reach out to the maintainers](mailto:i@moond4rk.com). + +Thank you for your contribution! + diff --git a/README.md b/README.md index d75d128..4347d64 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ # HackBrowserData -[![Lint](https://github.com/moonD4rk/HackBrowserData/actions/workflows/lint.yml/badge.svg)](https://github.com/moonD4rk/HackBrowserData/actions/workflows/lint.yml) [![build](https://github.com/moonD4rk/HackBrowserData/actions/workflows/build.yml/badge.svg)](https://github.com/moonD4rk/HackBrowserData/actions/workflows/build.yml) [![Release](https://github.com/moonD4rk/HackBrowserData/actions/workflows/release.yml/badge.svg)](https://github.com/moonD4rk/HackBrowserData/actions/workflows/release.yml) +[![Lint](https://github.com/moonD4rk/HackBrowserData/actions/workflows/lint.yml/badge.svg)](https://github.com/moonD4rk/HackBrowserData/actions/workflows/lint.yml) [![build](https://github.com/moonD4rk/HackBrowserData/actions/workflows/build.yml/badge.svg)](https://github.com/moonD4rk/HackBrowserData/actions/workflows/build.yml) [![Release](https://github.com/moonD4rk/HackBrowserData/actions/workflows/release.yml/badge.svg)](https://github.com/moonD4rk/HackBrowserData/actions/workflows/release.yml) [![run tests](https://github.com/moonD4rk/HackBrowserData/actions/workflows/unittest.yml/badge.svg)](https://github.com/moonD4rk/HackBrowserData/actions/workflows/unittest.yml) [![Coverage Status](https://coveralls.io/repos/github/moonD4rk/HackBrowserData/badge.svg)](https://coveralls.io/github/moonD4rk/HackBrowserData) [中文说明](https://github.com/moonD4rk/HackBrowserData/blob/master/README_ZH.md)