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

[WIP] Fix vale errors #152

Draft
wants to merge 21 commits into
base: develop
Choose a base branch
from
Draft

Conversation

RCheesley
Copy link
Contributor

@RCheesley RCheesley commented Dec 24, 2023

Hi folks!

🚧 WIP - still working on this PR.

👋 Intro

⚠️ This PR is based on #147 which should be merged first, ideally.

🤔 What's it doing?

This is a pretty monster PR which fixes a whole lot of spelling, grammar and other related issues.

NOTE: This does not address gendered terms, I was asked to split that into a separate PR - #151.

There are some general points which I've highlighted below and fixed project-wide:

  • Speech marks (“ “) should only be used for speech. Use ‘ ‘ otherwise.
  • Normatives is not a normally used word in English. I propose it should be replaced with regulations
  • Names are very western, Google Styleguide gives some examples to choose from so I've changed Alice / Bob -> Lucian / Rosario - reference: https://developers.google.com/style/examples#example-person-names
  • Timeframe I have changed to time frame (multiple places)
  • Proposals can be edited by authors before this many minutes passes -> Authors can edit proposals within this number of minutes

🚨 Things I came across while working on this PR

💡 Core changes we should recommend before changing in the docs

In these cases, I've had to use a command to turn off the failing Vale rules for the relevant blocks and then turn them back on again. These are strings from core, so I can't just change them in the docs as it wouldn't make sense to the user seeing something different in the application.

  • To be voted on should be changed to ‘to vote on’ in core (budgets)
  • Actions permissions can be set for each project -> Set action permissions for each project (change in core, budgets and meetings)
  • Disabled -> turned off; Enabled -> Turned on (in core, multiple areas)
  • The link to join the meeting will be available a few minutes before it starts -> The link to join the meeting displays a few minutes before it starts (meetings)

@andreslucena
Copy link
Member

@RCheesley I see lots of conflicts here, maybe we can start a new one from develop and cherry-pick what we need from this branch?

@RCheesley
Copy link
Contributor Author

Sure thing, it's quite a big task hence why it's taking so long!

@plaindocs
Copy link

@RCheesley drive by comment to say that even if the vale on / vale off don't work on RST headings, you can probably add My as an exception to the Case rule (though that would apply everywhere unless you get complicated).

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.

3 participants