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

Enhance system messages #457

Open
wants to merge 1 commit into
base: development
Choose a base branch
from
Open

Conversation

lcduong
Copy link
Contributor

@lcduong lcduong commented Nov 25, 2024

this PR resolves #441

Changing messages of tickets system.
Note: there' re still package name with pretix, as it got impact all codes so I'm not changing it in this PR.

Summary by Sourcery

Enhancements:

  • Update system messages to remove specific references to 'pretix' and make them more generic across the ecosystem.

Copy link

sourcery-ai bot commented Nov 25, 2024

Reviewer's Guide by Sourcery

This PR focuses on updating system messages and text throughout the application, primarily removing references to "pretix" in user-facing strings and plugin metadata. The changes are straightforward text modifications that make the system messaging more generic and brand-neutral.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Updated ticket secret generator descriptions to be more generic
  • Changed 'works with all pretix apps' to 'works with all apps in the ecosystem'
  • Removed 'pretix' prefix from signature scheme description
src/pretix/base/secrets.py
Simplified welcome message in dashboard
  • Changed welcome title from 'Welcome to pretix!' to just 'Welcome'
src/pretix/control/views/dashboards.py
Removed author attribution from plugin metadata
  • Removed 'author = _("the pretix team")' from all plugin configurations
src/pretix/plugins/badges/apps.py
src/pretix/plugins/banktransfer/apps.py
src/pretix/plugins/checkinlists/apps.py
src/pretix/plugins/manualpayment/apps.py
src/pretix/plugins/paypal/apps.py
src/pretix/plugins/pretixdroid/apps.py
src/pretix/plugins/reports/apps.py
src/pretix/plugins/returnurl/apps.py
src/pretix/plugins/sendmail/apps.py
src/pretix/plugins/statistics/apps.py
src/pretix/plugins/ticketoutputpdf/apps.py
src/pretix/plugins/webcheckin/apps.py

Assessment against linked issues

Issue Objective Addressed Explanation
#441 Remove 'Welcome to Pretix' message and replace with just 'Welcome'
#441 Remove or replace other instances of 'Pretix' with neutral terms in system messages

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @lcduong - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Please improve the commit message to clearly explain the motivation and goals behind removing pretix branding and author attributions. This will help future maintainers understand why these changes were made.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@@ -27,7 +27,7 @@ supports the following authorization schemes:
Permissions
-----------

The API follows pretix team based permissions model. Each organizer can have several teams
The API follows dev team based permissions model. Each organizer can have several teams
each with it's own set of permissions. Each team can have any number of API keys attached.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (typo): Grammatical error: 'it's' should be 'its' as this is the possessive form

@@ -72,7 +72,7 @@ A working example would be:

class PretixPluginMeta:
name = _("PayPal")
author = _("the pretix team")
author = _("the development team")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

change to ("FOSSASIA")

@@ -53,7 +53,7 @@ The alternative approach that is included with pretix is to choose a signature-b
These secrets include the most important information that is required for verifying their validity and use modern
cryptography to make sure they cannot be forged.

Currently, pretix ships with one such scheme ("pretix signature scheme 1") which encodes the product, the product
Currently, pretix ships with one such scheme ("signature scheme 1") which encodes the product, the product
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently, the platform ships with one such scheme ("signature scheme 1") which encodes the product, the product

@@ -283,7 +283,7 @@ def checkin_widget(sender, subevent=None, lazy=False, **kwargs):
def welcome_wizard_widget(sender, **kwargs):
template = get_template('pretixcontrol/event/dashboard_widget_welcome.html')
ctx = {
'title': _('Welcome to pretix!')
'title': _('Welcome')
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'title': _('Welcome!')

@@ -12333,7 +12333,7 @@ msgstr "ميزات أخرى"
#| "%(url)s\n"
#| "\n"
#| "Best regards,\n"
#| "Your pretix team\n"
#| "Your development team\n"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Your FOSSASIA team\n"

@@ -12373,7 +12373,7 @@ msgstr ""
#| "\n"
#| "Best regards,\n"
#| "\n"
#| "Your pretix team\n"
#| "Your development team\n"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Your FOSSASIA team\n"

@@ -12426,7 +12426,7 @@ msgstr ""
#| "%(url)s\n"
#| "\n"
#| "Best regards,\n"
#| "Your pretix team\n"
#| "Your development team\n"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FOSSASIA team

@@ -19267,7 +19267,7 @@ msgstr "شارات"
#: pretix/plugins/statistics/apps.py:13
#: pretix/plugins/ticketoutputpdf/apps.py:14
#: pretix/plugins/webcheckin/apps.py:13
msgid "the pretix team"
msgid "the development team"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FOSSASIA team

@@ -12203,7 +12203,7 @@ msgstr "Altres característiques"
#| "%(url)s\n"
#| "\n"
#| "Best regards,\n"
#| "Your pretix team\n"
#| "Your development team\n"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FOSSASIA team

@@ -12243,7 +12243,7 @@ msgstr ""
#| "\n"
#| "Best regards,\n"
#| "\n"
#| "Your pretix team\n"
#| "Your development team\n"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FOSSASIA team

@@ -18592,7 +18592,7 @@ msgstr "Targes d'identificació"
#: pretix/plugins/statistics/apps.py:13
#: pretix/plugins/ticketoutputpdf/apps.py:14
#: pretix/plugins/webcheckin/apps.py:13
msgid "the pretix team"
msgid "the development team"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FOSSASIA team

@@ -11,7 +11,6 @@ class PaypalApp(AppConfig):

class PretixPluginMeta:
name = _("PayPal")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

author = _("eventyay team")

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enhance system messages
2 participants