mirror of
https://github.com/trufflesecurity/trufflehog.git
synced 2024-11-10 07:04:24 +00:00
updating github templates (#1587)
* updating github templates * address miccahs comments * remove community note comment
This commit is contained in:
parent
3c79b6b133
commit
b906a51d5c
6 changed files with 30 additions and 25 deletions
6
.github/ISSUE_TEMPLATE/bug_report.md
vendored
6
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
@ -6,11 +6,7 @@ labels: bug, needs triage
|
||||||
assignees: trufflesecurity/product-eng
|
assignees: trufflesecurity/product-eng
|
||||||
---
|
---
|
||||||
|
|
||||||
### Community Note
|
Please Review the [Community Note](../community_note.md) before submitting
|
||||||
|
|
||||||
* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request
|
|
||||||
* Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
|
|
||||||
* If you are interested in working on this issue or have submitted a pull request, please leave a comment
|
|
||||||
|
|
||||||
### TruffleHog Version
|
### TruffleHog Version
|
||||||
<!--- Please run `trufflehog --version` to show the version. If you are not running the latest version, please upgrade because your issue may have already been fixed. --->
|
<!--- Please run `trufflehog --version` to show the version. If you are not running the latest version, please upgrade because your issue may have already been fixed. --->
|
||||||
|
|
26
.github/ISSUE_TEMPLATE/feature_request.md
vendored
26
.github/ISSUE_TEMPLATE/feature_request.md
vendored
|
@ -6,33 +6,27 @@ labels: enhancement, needs triage
|
||||||
assignees: trufflesecurity/product-eng
|
assignees: trufflesecurity/product-eng
|
||||||
---
|
---
|
||||||
|
|
||||||
### Community Note
|
Please Review the [Community Note](../community_note.md) before submitting
|
||||||
|
|
||||||
* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request
|
|
||||||
* Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
|
|
||||||
* If you are interested in working on this issue or have submitted a pull request, please leave a comment
|
|
||||||
|
|
||||||
### Description
|
|
||||||
|
|
||||||
|
## Description
|
||||||
<!--- Please leave a helpful description of the feature request here. --->
|
<!--- Please leave a helpful description of the feature request here. --->
|
||||||
|
|
||||||
## Problem to be Addressed
|
### Preferred Solution
|
||||||
<!--- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] --->
|
<!--- A clear and concise description of what you want to happen. What
|
||||||
|
information may be required and what would be the preferred way to provide it?
|
||||||
## Description of the Preferred Solution
|
|
||||||
<!--- A clear and concise description of what you want to happen. What
|
|
||||||
information may be required and what would be the preferred way to provide it?
|
|
||||||
What should the output include? --->
|
What should the output include? --->
|
||||||
|
|
||||||
## Additional Context
|
### Additional Context
|
||||||
<!--- Add any other context or screenshots about the feature request here. --->
|
<!--- Add any other context or screenshots about the feature request here. --->
|
||||||
|
|
||||||
### References
|
#### References
|
||||||
|
|
||||||
<!---
|
<!---
|
||||||
Information about referencing Github Issues: https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests
|
Information about referencing Github Issues: https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests
|
||||||
|
|
||||||
Are there any other GitHub issues (open or closed) or pull requests that should be linked here? Vendor blog posts or documentation? For example:
|
Are there any other GitHub issues (open or closed) or pull requests that should be linked here? Vendor blog posts or documentation? For example:
|
||||||
--->
|
|
||||||
|
|
||||||
* #0000
|
* #0000
|
||||||
|
--->
|
||||||
|
|
||||||
|
|
||||||
|
|
8
.github/PULL_REQUEST_TEMPLATE.md
vendored
8
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
@ -2,3 +2,11 @@
|
||||||
Please create an issue to collect feedback prior to feature additions. Please also reference that issue in any PRs.
|
Please create an issue to collect feedback prior to feature additions. Please also reference that issue in any PRs.
|
||||||
If possible try to keep PRs scoped to one feature, and add tests for new features.
|
If possible try to keep PRs scoped to one feature, and add tests for new features.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
### Description:
|
||||||
|
Explain the purpose of the PR.
|
||||||
|
|
||||||
|
### Checklist:
|
||||||
|
* [ ] Tests passing (`make test-community`)?
|
||||||
|
* [ ] Lint passing (`make lint` this requires [golangci-lint](https://golangci-lint.run/usage/install/#local-installation))?
|
||||||
|
|
||||||
|
|
7
.github/community_note.md
vendored
Normal file
7
.github/community_note.md
vendored
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
## Community Note
|
||||||
|
|
||||||
|
Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request.
|
||||||
|
|
||||||
|
Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.
|
||||||
|
|
||||||
|
If you are interested in working on this issue or have submitted a pull request, please leave a comment.
|
6
.github/workflows/test.yml
vendored
6
.github/workflows/test.yml
vendored
|
@ -52,8 +52,8 @@ jobs:
|
||||||
service_account: 'github-ci-external@trufflehog-testing.iam.gserviceaccount.com'
|
service_account: 'github-ci-external@trufflehog-testing.iam.gserviceaccount.com'
|
||||||
- name: Test
|
- name: Test
|
||||||
run: make test-detectors
|
run: make test-detectors
|
||||||
continue-on-error: true
|
continue-on-error: true
|
||||||
test-fork:
|
test-community:
|
||||||
if: ${{ github.event.pull_request.head.repo.fork }}
|
if: ${{ github.event.pull_request.head.repo.fork }}
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
permissions:
|
permissions:
|
||||||
|
@ -67,4 +67,4 @@ jobs:
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v3
|
||||||
- name: Test
|
- name: Test
|
||||||
run: make test-forks
|
run: make test-community
|
||||||
|
|
2
Makefile
2
Makefile
|
@ -39,7 +39,7 @@ test-race:
|
||||||
test-detectors:
|
test-detectors:
|
||||||
CGO_ENABLED=0 go test -tags=detectors -timeout=5m $(shell go list ./... | grep pkg/detectors)
|
CGO_ENABLED=0 go test -tags=detectors -timeout=5m $(shell go list ./... | grep pkg/detectors)
|
||||||
|
|
||||||
test-forks:
|
test-community:
|
||||||
CGO_ENABLED=0 go test -timeout=5m $(shell go list ./... | grep -v /vendor/ | grep -v pkg/detectors | grep -v pkg/sources)
|
CGO_ENABLED=0 go test -timeout=5m $(shell go list ./... | grep -v /vendor/ | grep -v pkg/detectors | grep -v pkg/sources)
|
||||||
|
|
||||||
bench:
|
bench:
|
||||||
|
|
Loading…
Reference in a new issue