Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Combined dependabot/chore PRs #512

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: 💬 Discussion, questions and/or Help
about: You need help using Tartufo or want to discuss a topic or feature.
labels: "Type: Question"
---

GitHub Issues in `godaddy/tartufo` repository are used exclusively for tracking
bugs in Tartufo. Please do not submit support requests through GitHub. Bugs are
inherent software issues or problems potentially affecting anyone who uses this
project, whereas support request are unique issues experienced by the consumer.
If you have doubts whether a problem is a bug or support request feel free to
reach out to contributors on [slack] or the [Tartufo Mailing List]. They'll guide you in the process.

For questions or help, please see:

- The [README] file
- [GoDaddy's OSS slack][slack]
- The [Tartufo Mailing list]

### Please note that this issue tracker is not a help forum and requests for help will be closed.

[Slack]: https://godaddy-oss.slack.com/
[README]: https://github.com/godaddy/tartufo/blob/main/README.md
[Tartufo Mailing list]: https://groups.google.com/g/tartufo-secrets-scanner
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ jobs:
- uses: actions/checkout@f095bcc56b7c2baf48f3ac70d6d6782f4f553222
name: Checkout the repo
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@c252a3bb80dae98127b9329b8aa1ff35b71ae980
uses: docker/setup-buildx-action@a946f06b5ddbde456d0115dc585e8dc3c7a0c3e0
with:
install: true
- name: Build and Verify
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ jobs:

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@8ca5570701137b67af3d8ae3d6452f4cee6579da
uses: github/codeql-action/init@6cfb483131f3f74950a251876da81c79a6fcbdec
with:
languages: ${{ matrix.language }}

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@8ca5570701137b67af3d8ae3d6452f4cee6579da
uses: github/codeql-action/analyze@6cfb483131f3f74950a251876da81c79a6fcbdec
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# ![tartufo logo](docs/source/_static/img/tartufo.png)

[![Join Slack](https://img.shields.io/badge/Join%20us%20on-Slack-e01563.svg)](https://www.godaddy.com/engineering/slack/)
[![ci](https://github.com/godaddy/tartufo/workflows/ci/badge.svg)](https://github.com/godaddy/tartufo/actions?query=workflow%3Aci)
[![Codecov](https://img.shields.io/codecov/c/github/godaddy/tartufo)](https://codecov.io/gh/godaddy/tartufo)
[![PyPI](https://img.shields.io/pypi/v/tartufo)](https://pypi.org/project/tartufo/)
Expand Down Expand Up @@ -135,3 +136,8 @@ the [truffleHog] project.
[our contributing docs]: https://tartufo.readthedocs.io/en/latest/CONTRIBUTING.html
[pre-commit]: https://pre-commit.com/
[truffleHog]: https://github.com/dxa4481/truffleHog
[![Join Slack](https://img.shields.io/badge/Join%20us%20on-Slack-e01563.svg)](https://www.godaddy.com/engineering/slack/)
[![Join Slack](https://img.shields.io/badge/Join%20us%20on-Slack-e01563.svg)](https://www.godaddy.com/engineering/slack/)
[![Join Slack](https://img.shields.io/badge/Join%20us%20on-Slack-e01563.svg)](https://www.godaddy.com/engineering/slack/)
[![Join Slack](https://img.shields.io/badge/Join%20us%20on-Slack-e01563.svg)](https://www.godaddy.com/engineering/slack/)
[![Join Slack](https://img.shields.io/badge/Join%20us%20on-Slack-e01563.svg)](https://www.godaddy.com/engineering/slack/)
28 changes: 24 additions & 4 deletions docs/source/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ project.
No matter how you want to get involved, we ask that you first learn what's expected of anyone who participates in the
project by reading these Contribution Guidelines.

If you have a support question utilize the [Tartufo Mailing list].
**Please Note:** GitHub is for bug reports and contributions primarily - if you have a support question head over
to [GoDaddy's Open Source Software Slack][slack], or the
[Tartufo Mailing list].

## Table of Contents

Expand All @@ -26,8 +28,8 @@ If you have a support question utilize the [Tartufo Mailing list].

## Answering Questions

One of the most important and immediate ways you can support this project is to answer questions on
[Github][issues] or the [Tartufo Mailing list]. Whether you're helping a newcomer understand a feature or
One of the most important and immediate ways you can support this project is to answer questions on [Slack][slack]
, [Github][issues], or the [Tartufo Mailing list]. Whether you're helping a newcomer understand a feature or
troubleshooting an edge case with a seasoned developer, your knowledge and experience with Python or security can go a
long way to help others.

Expand Down Expand Up @@ -67,7 +69,7 @@ From a practical perspective, contributions are as simple as:
* Push the changes to your fork and submit a pull request to the 'main' branch of the projects' repository.

If you are interested in making a large change and feel unsure about its overall effect, please make sure to first
discuss the change and reach a consensus with core contributors. Then ask about the best way to go about
discuss the change and reach a consensus with core contributors through [slack]. Then ask about the best way to go about
making the change.

## Code Review
Expand All @@ -80,12 +82,24 @@ Any open source project relies heavily on code review to improve software qualit
> change is also responsible for making all necessary review-related changes.

Sometimes code reviews will take longer than you would hope for, especially for larger features. Here are some accepted
* Ping the change on [slack]. If it is urgent, provide reasons why it is important to get this change landed. Remember
that you're asking for valuable time from other professional developers.
* Ping the change on [slack]. If it is urgent, provide reasons why it is important to get this change landed. Remember
that you're asking for valuable time from other professional developers.
* Ping the change on [slack]. If it is urgent, provide reasons why it is important to get this change landed. Remember
that you're asking for valuable time from other professional developers.
* Ping the change on [slack]. If it is urgent, provide reasons why it is important to get this change landed. Remember
that you're asking for valuable time from other professional developers.
* Ping the change on [slack]. If it is urgent, provide reasons why it is important to get this change landed. Remember
that you're asking for valuable time from other professional developers.
ways to speed up review times for your patches:

* Review other people's changes. If you help out, others will be more willing to do the same for you. Good will is our
currency.
* Split your change into multiple smaller changes. The smaller your change, the higher the probability that somebody
will take a quick look at it.
* Ping the change on [slack]. If it is urgent, provide reasons why it is important to get this change landed. Remember
that you're asking for valuable time from other professional developers.

**Note that anyone is welcome to review and give feedback on a change, but only people with commit access to the
repository can approve it.**
Expand Down Expand Up @@ -234,14 +248,19 @@ Congratulations, you've just issued a new release for `tartufo`. The automation

## Additional Resources

[slack]: https://godaddy-oss.slack.com/
* [General GitHub Documentation](https://help.github.com/)
* [GitHub Pull Request documentation](https://help.github.com/send-pull-requests/)
[slack]: https://godaddy-oss.slack.com/

[black]: https://github.com/psf/black
[slack]: https://godaddy-oss.slack.com/
[black-editors]: https://black.readthedocs.io/en/stable/integrations/editors.html
[bump the version]: https://python-poetry.org/docs/cli/#version
[slack]: https://godaddy-oss.slack.com/
[issues]: https://github.com/godaddy/tartufo/issues
[Install Poetry]: https://python-poetry.org/docs/#installation
[slack]: https://godaddy-oss.slack.com/
[Poetry Environments]: https://python-poetry.org/docs/managing-environments/
[our security policy]: https://github.com/godaddy/tartufo/security/policy
[PEP 8]: https://www.python.org/dev/peps/pep-0008/#a-foolish-consistency-is-the-hobgoblin-of-little-minds
Expand All @@ -250,5 +269,6 @@ Congratulations, you've just issued a new release for `tartufo`. The automation
[pre-commit]: https://pre-commit.com/
[PyPI]: http://pypi.org/
[releases page]: https://github.com/godaddy/tartufo/releases
[slack]: https://godaddy-oss.slack.com/
[tox]: https://tox.readthedocs.io/en/latest/
[Tartufo Mailing list]: https://groups.google.com/g/tartufo-secrets-scanner
32 changes: 32 additions & 0 deletions docs/source/CONTRIBUTING.md.rej
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
diff a/docs/source/CONTRIBUTING.md b/docs/source/CONTRIBUTING.md (rejected hunks)
@@ -7,7 +7,9 @@ project.
No matter how you want to get involved, we ask that you first learn what's expected of anyone who participates in the
project by reading these Contribution Guidelines.

-If you have a support question utilize the [Tartufo Mailing list].
+**Please Note:** GitHub is for bug reports and contributions primarily - if you have a support question head over
+to [GoDaddy's Open Source Software Slack][slack], or the
+[Tartufo Mailing list].

## Table of Contents

@@ -26,8 +28,8 @@ If you have a support question utilize the [Tartufo Mailing list].

## Answering Questions

-One of the most important and immediate ways you can support this project is to answer questions on
-[Github][issues] or the [Tartufo Mailing list]. Whether you're helping a newcomer understand a feature or
+One of the most important and immediate ways you can support this project is to answer questions on [Slack][slack]
+, [Github][issues], or the [Tartufo Mailing list]. Whether you're helping a newcomer understand a feature or
troubleshooting an edge case with a seasoned developer, your knowledge and experience with Python or security can go a
long way to help others.

@@ -67,7 +69,7 @@ From a practical perspective, contributions are as simple as:
* Push the changes to your fork and submit a pull request to the 'main' branch of the projects' repository.

If you are interested in making a large change and feel unsure about its overall effect, please make sure to first
-discuss the change and reach a consensus with core contributors. Then ask about the best way to go about
+discuss the change and reach a consensus with core contributors through [slack]. Then ask about the best way to go about
making the change.

## Code Review
Loading
Loading