chaynhq / soulmedicine Goto Github PK

When filling in the form to create an account or sign in, the buttons still appear "grayed out" even once all of the required information has been filled in. This is confusing and can make the user wonder if they haven't done everything needed in order to proceed.

Overview

Currently, our README links interested volunteers directly to the volunteer form, not to our volunteer info page (which contains the form). We need the README to link to the Getting Involved volunteer info page instead, similar to how our CONTRIBUTING.md file does.

Action Items

• Replace the text in the README.md under the Getting Involved section:
  If you would like to help Bloom and receive special access to our organization and volunteer opportunities, please get in touch with us to express your interest in volunteering via this form."
  with the following text:
  "If you would like to help Chayn and receive special access to our organization and volunteer opportunities, please visit our Getting Involved page."
• Make sure the above sentence contains a markdown link to our Getting Involved page: https://www.notion.so/chayn/Get-involved-423c067536f3426a88005de68f0cab19?pvs=4

Please disregard failing tests as we are updating their performance. Thank you!

Resources/Instructions

• How to make Markdown Links

The current system is running on Ruby 2.5.8 which reached EOL in April of 2021.

We need to upgrade the system to use Ruby 3.2 to ensure that we are secure and the most up to date that is possible.

Below is the order in which the update is recommended.

• 2.7 (the last of the 2 series)
• 3.0
• 3.1.4

These should be updated with as few dependencies updated as possible to avoid breaking changes during the upgrade process. Once we're on the latest version of Ruby, we can then look at tackling the Rails framework updates.

Overview

Create a security policy to guide contributors through reporting a security vulnerability on Bloom.
Additionally this helps fulfill Community Standards for this repo.

Action Items

• Use GitHub's click-through process for maintainers to easily add universal security policies to their repos, found in this repos security tab.
• Then copy paste Chayn's security policy from YSM.

Resources/Instructions

• Official GitHub Docs - Adding a security policy to your repository

As of #305 we're now officially on GitHub Actions 🎉

We should remove the Travis CI GitHub App from the organization as it's no longer being used.

The "Got it!" button used to accept cookies is very low contrast (1.70)

Overview

Add a CODE_OF_CONDUCT.md file for contributors to abide by when contributing to Soul Medicine.
Additionally this helps fulfill Community Standards for this repo.

Action Items

• Use GitHub's click-through process for maintainers to easily add universal CoC templates to their repos.
• Edit to align with Chayn's values if necessary.

Resources

• Official GitHub Docs - Adding a code of conduct to your project

When I'm signed in to the site and click my name -> "my profile", it takes me to a page that says "Please sign in again to view and change your profile" and forces me to sign in a second time.

This feels frustrating and redundant. Is there a reason users are required to sign in again in order to view their profile?

I believe this is not a big deal however for picky users like me this button seemed like if it were disabled so probably making it less transparent could remove that confusion.

Example page: https://soulmedicine.io/en/pathways/how-to-open-your-own-bank-account/subscription

Time slot is listed from 23:00 - 25:00, it shoud be 23:00 - 24:00

Example page: https://soulmedicine.io/ar/auth/sign_in

What It Means
A form control does not have a corresponding label.

Why It Matters: If a form control does not have a properly associated text label, the function or purpose of that form control may not be presented to screen reader users. Form labels also provide visible descriptions and larger clickable targets for form controls.

How to Fix It: If a text label for a form control is visible, use the element to associate it with its respective form control. If there is no visible label, either provide an associated label, add a descriptive title attribute to the form control, or reference the label(s) using aria-labelledby. Labels are not required for image, submit, reset, button, or hidden form controls.

Overview

We need to configure PR templates to guide contributors through submitting pull requests on Soul Medicine.
Additionally this helps fulfill Community Standards for this repo.

Action Items

• Research project-specific requirements before opening a PR on Soul Medicine.
• Configure pull request templates.

Resources

• Official GitHub Docs - Creating a pull request template for your repository
• Example PR templates

Example page: https://soulmedicine.io/en/pathways/diy-online-safety/notes/note-1-how-many-sites-and-services-do-you-use & https://soulmedicine.io/en/profile

What It Means: An aria-labelledby or aria-describedby reference exists, but the target for the reference does not exist.

Why It Matters: ARIA labels and descriptions will not be presented if the element referenced does not exist in the page.

How to Fix It: Ensure the element referenced in the aria-labelledby or aria-describedby attribute value is present within the page and presents a proper label or description.

Overview

We need to create a detailed CONTRIBUTING.md file to guide developers of all levels contributing to Soul Medicine.
Additionally this helps fulfill Community Standards for this repo.

Action Items

• Check out resources below as a guide.
• Research project-specific requirements.
• Draft CONTRIBUTING.md and open a PR.

Resources

• Official GitHub contributing guidelines guide
• Example CONTRIBUTING.md file by GitHub
• Example CONTRIBUTING.md file by Ruby for Good

Example page: https://soulmedicine.io/en/pathways/how-to-manage-your-money

Why It Matters: Identifying the language of the page allows screen readers to read the content in the appropriate language. It also facilitates automatic translation of content.

How to Fix It: Identify the document language using the attribute <html lang="en">

When a user clicks the "leave this site" button (which is an awesome UX feature!), they remain signed in. It might be a good idea to also log the user out.

While the browser history will remain intact for that session, if the site is navigated to by a bad actor (ie: the abuser) and the account is still logged in, both the existence of an account and any subscriptions will be viewable. This seems undesirable.

Example page: https://soulmedicine.io/en

What It Means: Two images near each other have the same alternative text.

Why It Matters: When two images have the same alternative text, this often causes redundancy or indicates incorrect alternative text.

How to Fix It: Ensure that the alternative text for each image or image button is appropriate while removing unnecessary redundancy. If the content of the image is already conveyed elsewhere (through text or the alternative text of a nearby image) or if the image does not convey content, the image may generally be given empty/null alternative text (alt=""). Image buttons always convey a specific function, and thus cannot be given null alternative text.

According to the Node release schedule Node 18 will be supported until April of 2025. In order to ensure stability of the platform we need to upgrade from our current version of Node 10.

Below is the recommended upgrade order:

• 14.x (EOL 2023-04)
• 16.x (EOL 2023-09-11)
• 18.x (LTS)

These should be updated with as few dependencies updated as possible to avoid breaking changes during the upgrade process. Once we're on Node 18 we can look at updating the other dependencies of the project.

A security update was recently committed – #176 – but this has broken certain UI interactions.

Need to go through the release notes and figure out what needs fixing – may need an upgrade to Bootstrap itself (as it's the Bootstrap components that are likely broken).

The measure, or length of the lines of text, on pathway notes pages is a bit long (~153 characters / 31 words).

To make the long form notes easier to read and more approachable, consider capping their length to something closer to ~80 characters --even a reduction to 100 characters could provide a noticeable improvement for readers.

reference: https://tachyons.io/docs/typography/measure/

Found a couple of typos on the How to cope with stress page:

"A lot of experience stress on a day to day basis." -- Seems like this should read as "A lot of people experience stress..."

"In this course, we will help you understand how your body and mind reacts to stress," -- I think the word "reacts" should be changed to "react".

Overview

Now that we have migrated to Rails 7 #372 we need to update the framework to be up to date as well.

See the file for more details.

These default are meant to be turned on either individually or in small batches as they are breaking changes inside of the application.

Action Items

• Understand each change in the new_framework_defaults_7_0.rb file.
• Ship each change safely by deploying first to the staging heroku environment.
• The merge and deploy to production.

Resources

https://guides.rubyonrails.org/upgrading_ruby_on_rails.html#upgrading-from-rails-6-1-to-rails-7-0

When hovering over "Chayn" in the "Powered by Chayn" banner across the bottom of the home page, the word "Chayn" gets lost. The hover color for the hyperlinks is almost the exact same shade of pink as the background color. (I understand that this is the hover color for all the hyperlinks on the page, but it feels like an accessibility issue to have the link basically disappear upon hover).

Our travis integration is not currently working and we've decided not to fix it as Travis is proving challenging to fix and we don't want to migrate plans. To simplify our stack we want to migrate travis continuous integration to Github actions.
Approach

• have a look at this quickstart guide https://docs.github.com/en/actions/quickstart
• create a new branch to work on
• replicate the steps in travis in github actions
• if you need help with storing secrets for github actions contact the team (@swetha-charles or @eleanorreem)
• note that we want the travis CI to run at the same point in the development flow (i.e. on pull request creation)
• Commit any changes to the branch and push up
• Comment on the ticket about the changes made and request reviews from the team (@swetha-charles or @eleanorreem)

Overview

We need to configure issues templates to guide contributors through creating issues on Soul Medicine.
Additionally this helps fulfill Community Standards for this repo.

Action Items

• Use example issue templates from YSM as a template.
• Configure issue templates on this repo (start with Blank, Feature Request, and Bug Report)

Resources

• Official GitHub Docs - Configuring issue templates for your repository

To reduce the number of third party integrations and overhead, we'd like to move from Snyk to GitHub's secuirty feature.

• Enable Code Scanning Alerts via https://github.com/chaynHQ/soulmedicine/security/code-scanning
• Have an Snyk account admin remove the integration to this organization or repository
• Close outstanding issues and pull requests from Snyk as Dependabot has these covered.

Overview

We need to link to the CONTRIBUTING.md file in the README.md so contributors can more easily see the contributing guidelines.

Action Items

• Under the title in the "Development and Testing" section in the README.md, add the following:
  "To make a contribution, please read our Contributing Guidelines in CONTRIBUTING.md"
• Make sure the sentence above contains a Markdown link to the repo's CONTRIBUTING.md file.

Please disregard failing tests as we are updating their performance. Thank you!

Resources/Instructions

• How to Create Markdown Links

Overview

Implement a GitHub Action that will automatically welcome contributors in issues.

Action Items

• Draft an informative message linking contributors to helpful information.
• Write a new workflow and submit a PR.

Resources

https://github.com/marketplace/actions/auto-message-for-pr-s-and-issues
https://github.com/actions/first-interaction
https://github.com/marketplace/actions/first-interaction
https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#issue_comment