From 58eb225961cbe9d555f3aebcfa6493fad79718de Mon Sep 17 00:00:00 2001 From: Jim Brandt Date: Wed, 27 Mar 2024 08:18:03 -0400 Subject: [PATCH 1/3] Add logo and style to README for better github display --- README.md | 57 ++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 44 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index e44b7fcafe5..ed0e37f1e8f 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,44 @@ - -# RT is an enterprise-grade issue tracking system. - +

+ + Best Practical logo + +

+ +

Request Tracker (RT)

+ +

+ RT is an open source, enterprise-grade issue and ticket tracking system. +
+ Explore RT docs » +
+
+ Release Notes + · + Community Forum + · + Public Wiki + · + Blog + · + Hosting & Support +

+ + Latest release + + + Build status + +

+ +

RT allows organizations to keep track of what needs to get done, who is working on which tasks, what's already been done, and when tasks were (or weren't) completed. - +

+

RT doesn't cost anything to use, no matter how much you use it; it is freely available under the terms of Version 2 of the GNU General Public License. - -RT is commercially-supported software. To purchase hosting, support, training, custom development, or professional services, please get in touch with us at . +

+

+RT is commercially-supported software. To purchase hosting, support, training, custom development, or professional services, please get in touch with us at sales@bestpractical.com. +

![Screenshot of RT](docs/images/screenshot.png) @@ -308,12 +341,12 @@ into on the Community Forum (or pick up a commercial support contract from Best Practical). But, sometimes people do run into bugs. In the exceedingly unlikely event that you hit a bug in RT, please report it! We'd love to hear about problems you have with RT, so we can -fix them. To report a bug, send email to . - -Note that this sends email to our public RT instance. Do not include any -information in your email that you don't want shown publicly, including -contact information in your email signature. +fix them. +To report a bug, go to our [public RT instance](https://rt.bestpractical.com) +and create a ticket. Note that this is a public RT instance, so the information +you share will be visible to others. You can browse some other bug tickets +to see what is shown. # COPYRIGHT AND LICENSE @@ -362,5 +395,3 @@ royalty-free, perpetual, license to use, copy, create derivative works based on those contributions, and sublicense and distribute those contributions and any derivatives thereof. - -# From 45d624a85c4ab031260f78468fdc2088fd585eeb Mon Sep 17 00:00:00 2001 From: Jim Brandt Date: Thu, 28 Mar 2024 10:46:06 -0400 Subject: [PATCH 2/3] Copy security contact information to a SECURITY.md file Github will show this as a tab above our README. --- SECURITY.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 SECURITY.md diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000000..7068dcd6451 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,7 @@ +# Reporting Security Vulnerabilities + +If you believe you've discovered a security issue in RT, please send an +email to `security@bestpractical.com` with a detailed description of the +issue, and a secure means to respond to you (such as your PGP public +key). You can find our PGP key and fingerprint at +[https://bestpractical.com/security/](https://bestpractical.com/security/). From 7d4b2c81246c7cd837413c71ea54e1846f3e1e7a Mon Sep 17 00:00:00 2001 From: Jim Brandt Date: Thu, 28 Mar 2024 10:51:56 -0400 Subject: [PATCH 3/3] Rename github actions file to describe what it does This also makes the README badge better show that tests are all passing (or not). --- .github/workflows/{github-action.yml => test-all.yml} | 0 README.md | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) rename .github/workflows/{github-action.yml => test-all.yml} (100%) diff --git a/.github/workflows/github-action.yml b/.github/workflows/test-all.yml similarity index 100% rename from .github/workflows/github-action.yml rename to .github/workflows/test-all.yml diff --git a/README.md b/README.md index ed0e37f1e8f..7ccc11320e1 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ Latest release - Build status + Build status