From f1bed94fb85a4df87a05deb889e72c56c62f97f7 Mon Sep 17 00:00:00 2001 From: ux-git <80993061+ux-git@users.noreply.github.com> Date: Thu, 12 Dec 2024 15:01:36 +0100 Subject: [PATCH 1/4] New issue form templates --- .github/ISSUE_TEMPLATE/bug_report.md | 38 --------- .github/ISSUE_TEMPLATE/bug_report.yml | 85 +++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 9 +- .github/ISSUE_TEMPLATE/feature_request.md | 20 ----- .github/ISSUE_TEMPLATE/feature_request.yml | 23 +++++ .../ISSUE_TEMPLATE/major-change-request.md | 20 ----- .../ISSUE_TEMPLATE/new_language_request.yml | 55 ++++++------ 7 files changed, 144 insertions(+), 106 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml delete mode 100644 .github/ISSUE_TEMPLATE/major-change-request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 98681a38c4..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "[FIX] " -labels: '' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000000..84ef68c9f8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,85 @@ +name: Bug report +description: Report any bugs or issues, and we'll fix them! +title: "[FIX] " +labels: ["bug"] +assignees: '' +body: + - type: markdown + attributes: + value: | + Before submitting, we encourage you to check our [User guide](https://guide.organized-app.com/) and search through existing issues and discussions to avoid duplicates. Also, make sure you're using the latest version of the app. Thank you for helping us improve Organized! + - type: textarea + attributes: + label: 'Describe the bug:' + placeholder: | + Provide a clear and concise description of the issue you encountered. + validations: + required: true + - type: textarea + attributes: + label: 'Steps to reproduce the issue:' + placeholder: | + 1. + 2. + 3. + ... + validations: + required: true + - type: textarea + attributes: + label: 'Expected behavior:' + placeholder: | + What did you expect to happen? + validations: + required: true + - type: textarea + attributes: + label: 'Screenshots' + placeholder: | + What actually happened? + validations: + required: false + - type: markdown + attributes: + value: | + Please include any relevant screenshots, videos, or console logs that can help us identify and solve the problem faster. + - type: dropdown + id: platform + attributes: + label: 'Which platform can you reproduce the bug on?' + options: + - Desktop + - Mobile (in browser) + - Mobile (installed as PWA) + - All platforms + default: 0 + validations: + required: true + - type: dropdown + id: os + attributes: + label: 'Your operating system:' + options: + - Windows + - macOS + - Linux + - Android + - iOS + - Other (mention in details) + default: 0 + validations: + required: true + - type: textarea + attributes: + label: 'App version:' + placeholder: | + For example: v.3.0.0 + validations: + required: true + - type: textarea + attributes: + label: 'Additional information' + placeholder: | + Optional: Add any additional context that might be helpful. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 06f49ca804..365625b4df 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,10 @@ blank_issues_enabled: false contact_links: - - name: Community Support + - name: Have a question or need help with the app? url: https://github.com/sws2apps/organized-app/discussions - about: Please ask and answer questions here + about: | + Visit our Discussions to get support from other users or share your experience. + - name: Get started - explore the User Guide" + url: https://guide.organized-app.com/ + about: | + It provides easy-to-follow steps and useful tips for both beginners and experienced users. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 48cded0d09..0000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "[FEAT] " -labels: '' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000000..52d8ee72b7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,23 @@ +name: Feature request +description: Suggest a new feature or enhancement for Organized. +title: "[FEATURE] " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Before submitting, we encourage you to check our [User guide](https://guide.organized-app.com/) and Roadmap to explore available features and those already planned. Additionally, please search through existing issues and discussions to avoid duplicates. Thank you for helping us improve Organized! + - type: textarea + attributes: + label: 'Feature description:' + placeholder: | + Describe the current problem and your solution, and how it would benefit users. + validations: + required: true + - type: textarea + attributes: + label: 'Alternatives considered:' + placeholder: | + Share any alternative solutions or workarounds you've considered, if applicable. + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/major-change-request.md b/.github/ISSUE_TEMPLATE/major-change-request.md deleted file mode 100644 index c9b6f80a68..0000000000 --- a/.github/ISSUE_TEMPLATE/major-change-request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Major change request -about: Suggest a major update for this project -title: "[BREAK] " -labels: '' -assignees: '' - ---- - -**Is your major update related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/new_language_request.yml b/.github/ISSUE_TEMPLATE/new_language_request.yml index 4b99f8c1c4..03bb221199 100644 --- a/.github/ISSUE_TEMPLATE/new_language_request.yml +++ b/.github/ISSUE_TEMPLATE/new_language_request.yml @@ -1,57 +1,60 @@ -name: New translation language for the Organized app -description: Request a new language to be added to Crowdin platform -title: '[Language] - New Language Request' +name: New language request +description: Suggest a new language to add to Crowdin platform for further translation. +title: '[Enter your language here] - New language request' labels: [i18n] body: - type: markdown attributes: value: | - Add an issue title with this format: [Language] - New Language Request + Add an issue title in this format: [English] - New language request - type: input attributes: label: 'Enter the jw.org url to access this language:' placeholder: | - https://www.jw.org + for example: jw.org/en/ validations: required: true - type: markdown attributes: value: | - We can do an AI-based translation of the language, if you send us the list of translations in your language. Afterwards, you will be able to proofread text strings instead of translating everything from scratch. + We can provide AI-generated pre-translations if you send us your language's translation list. This way, you can focus on proofreading rather than starting from scratch. While the pre-translations may not be perfect, many strings will already be accurately translated, saving you hours of work. - type: textarea attributes: - label: 'Please provide translations for the following terms in your language:' + label: 'Please provide translations for the following theocratic terms in your language:' value: | - Congregation: Assignment: - Publisher: - Meeting: - Midweek meeting: - Weekend meeting: - Circuit overseer: Student (of a meeting): Assistant (of a student): + Bible study: + Branch office: + Bethel: + Chairman: + Congregation: + Circuit overseer: + Circuit overseer visit: Elder: + Governing Body Update (video): + Kingdom Hall: Ministerial servant: Ministry: - Service: - Report: - Meeting Schedule: + Meeting: + Meeting schedule: + Meeting workbook: + Memorial: + Midweek meeting: + Weekend meeting: + Organizational Accomplishments (video): Schedule: + Service: + Publisher: + Prayer: Pioneer application: - Auxiliary pioneer: + Report: + Reader: Regular pioneer: + Auxiliary pioneer: Speaker: Talk: - Memorial: - Chairman: - Prayer: - Reader: - Meeting workbook: - Governing Body Update (video): - Organizational Accomplishments (video): - Branch office: - Bethel: Territory: validations: required: true From 100c8e3844838af4cbb474cb7acff5c6ed78362f Mon Sep 17 00:00:00 2001 From: ux-git <80993061+ux-git@users.noreply.github.com> Date: Thu, 12 Dec 2024 15:05:36 +0100 Subject: [PATCH 2/4] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8e53b25007..732c9fd827 100644 --- a/README.md +++ b/README.md @@ -133,12 +133,12 @@ To learn more about Organized and how to use it, check out the following useful | Link | Description | | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | -| [Organized app](https://organized-app.com) | Open and use the Organized app. | +| [Organized app](https://organized-app.com) | Open the link and start using the Organized app. | | [Organized test mode](https://test.organized-app.com) | Preview environment of the app with pre-filled data, where you can test its features without registration. | | [About Organized](https://about.organized-app.com) | Learn more about the goals, features, and benefits of the Organized app. Feel free to share this link with others. | | [Video tutorials](https://www.youtube.com/@organized-app) | Watch on our YouTube channel video tutorials and guides on using and contributing. | | [User guide](https://guide.organized-app.com) | Read our text documentation to learn how to get started with the app and discover its various features. | -| [Our blog](https://guide.organized-app.com/blog) | Blog with insightful articles filled with tips, tricks, and the latest app update news. | -| [Translation project](https://crowdin.com/project/organized) | Collaborate on translating the Organized app – it's easy and convenient. | +| [Our blog](https://guide.organized-app.com/blog) | Blog with insightful articles filled with tips and tricks. | +| [Translation project](https://translate.organized-app.com) | Collaborate on translating the Organized app – it's easy and convenient. | | [Contribution guide](https://github.com/sws2apps/organized-app/blob/main/CONTRIBUTING.md) | See how you can contribute to the Organized project. | | [Telegram channel](https://t.me/+OHxW4AxGTyAxN2Zk) | Get all the latest announcements, release notes, and other useful info instantly in your Telegram messenger. From ae948b522d29d44b72cfc42ced75eb3d5c356bd1 Mon Sep 17 00:00:00 2001 From: ux-git <80993061+ux-git@users.noreply.github.com> Date: Thu, 12 Dec 2024 15:30:30 +0100 Subject: [PATCH 3/4] forms fixes --- .github/ISSUE_TEMPLATE/bug_report.yml | 1 - .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- .github/ISSUE_TEMPLATE/new_language_request.yml | 6 +++--- 4 files changed, 5 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 84ef68c9f8..687f74323a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -2,7 +2,6 @@ name: Bug report description: Report any bugs or issues, and we'll fix them! title: "[FIX] " labels: ["bug"] -assignees: '' body: - type: markdown attributes: diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 365625b4df..083fea7bff 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -4,7 +4,7 @@ contact_links: url: https://github.com/sws2apps/organized-app/discussions about: | Visit our Discussions to get support from other users or share your experience. - - name: Get started - explore the User Guide" + - name: Explore our User Guide url: https://guide.organized-app.com/ about: | It provides easy-to-follow steps and useful tips for both beginners and experienced users. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 52d8ee72b7..d7e52d22ed 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,6 +1,6 @@ name: Feature request description: Suggest a new feature or enhancement for Organized. -title: "[FEATURE] <title>" +title: "[FEAT] " labels: ["enhancement"] body: - type: markdown diff --git a/.github/ISSUE_TEMPLATE/new_language_request.yml b/.github/ISSUE_TEMPLATE/new_language_request.yml index 03bb221199..96d1999ea1 100644 --- a/.github/ISSUE_TEMPLATE/new_language_request.yml +++ b/.github/ISSUE_TEMPLATE/new_language_request.yml @@ -11,7 +11,7 @@ body: attributes: label: 'Enter the jw.org url to access this language:' placeholder: | - for example: jw.org/en/ + jw.org/en/ validations: required: true - type: markdown @@ -60,8 +60,8 @@ body: required: true - type: input attributes: - label: 'Do you feel fluent to be a proofreader of the language? If yes, please provide your Crowdin username:' + label: 'Are you fluent to proofread the translations? If yes, provide your Crowdin username:' placeholder: | - Yes, I can proofread the translations. My Crowdin username is... + Yes, my Crowdin username is... validations: required: false From 3c240efdbe74a983157e2d8e25b8c002c50b0fb5 Mon Sep 17 00:00:00 2001 From: ux-git <80993061+ux-git@users.noreply.github.com> Date: Thu, 12 Dec 2024 15:39:14 +0100 Subject: [PATCH 4/4] form fixes --- .github/ISSUE_TEMPLATE/bug_report.yml | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 687f74323a..d1e22db36c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -30,18 +30,14 @@ body: placeholder: | What did you expect to happen? validations: - required: true + required: false - type: textarea attributes: label: 'Screenshots' placeholder: | - What actually happened? + Include any relevant screenshots, videos, or console logs that can help us identify and solve the problem faster. validations: required: false - - type: markdown - attributes: - value: | - Please include any relevant screenshots, videos, or console logs that can help us identify and solve the problem faster. - type: dropdown id: platform attributes: @@ -64,11 +60,11 @@ body: - Linux - Android - iOS - - Other (mention in details) + - Other (please specify) default: 0 validations: required: true - - type: textarea + - type: input attributes: label: 'App version:' placeholder: |