diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index e2b1f8bd..00000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -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 diff --git a/README.md b/README.md index 50201880..29681eae 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ # ![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/) diff --git a/docs/source/CONTRIBUTING.md b/docs/source/CONTRIBUTING.md index dfedad43..8910a348 100644 --- a/docs/source/CONTRIBUTING.md +++ b/docs/source/CONTRIBUTING.md @@ -7,9 +7,7 @@ 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. -**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]. +If you have a support question utilize the [Tartufo Mailing list]. ## Table of Contents @@ -28,8 +26,8 @@ to [GoDaddy's Open Source Software Slack][slack], or the ## Answering Questions -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 +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 troubleshooting an edge case with a seasoned developer, your knowledge and experience with Python or security can go a long way to help others. @@ -69,7 +67,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 through [slack]. Then ask about the best way to go about +discuss the change and reach a consensus with core contributors. Then ask about the best way to go about making the change. ## Code Review @@ -88,8 +86,6 @@ ways to speed up review times for your patches: 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.** @@ -254,6 +250,5 @@ 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