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

Fix: open participation page accessibility issues (Axe) #32

Merged
merged 11 commits into from
Oct 18, 2024

Conversation

thomassth
Copy link

@thomassth thomassth commented Oct 17, 2024

Fix https://github.com/orgs/CivicTechTO/projects/4/views/1?filterQuery=parti&pane=issue&itemId=82264013

WAVE highlighted more items & would need more structural change, will do in another commit.

@patcon
Copy link
Member

patcon commented Oct 17, 2024

@thomassth i think may have intended to base this PR off of what is now called edge, instead of the current edge-civictechto (the prior edge branch accidentally had some extra commits from me, so I renamed it to be more clearly our branch, and locked the new edge to only sync with upstream. Hopefully this avoids future confusion

I don't think compdem will accept your PR upstream until you rebase, as there's some unrelated commits related to our storybook prep in there :)

@NewJerseyStyle
Copy link
Member

NewJerseyStyle commented Oct 17, 2024

About branch name, sorry I didn't state clearly in the documentation before.

When you create a branch:

If you are fixing a bug

Name the branch with fix/issue-<issue number>-<key word of issue> (e.g. fix/issues-25-display-button)

If you are adding feature described in issues

Name the branch with feature/<key word about feature>-issue-<issue number> (e.g. feature/a11y-module-issue-13)

If the branch does not associate to any issue

We will get confused

Creating PR

Create pull request to our edge branch from your repository/branch with changelog (so we know what you did, then we can verify your changes and test the code for integration test) in case changelog is too trivial for you, leverage AIs to write it is also a good idea. 🙇

More about development

Fixes issue with docker build failing due to makefile typo
@NewJerseyStyle NewJerseyStyle changed the base branch from edge-civictechto to edge October 17, 2024 20:14
@NewJerseyStyle NewJerseyStyle changed the base branch from edge to edge-civictechto October 17, 2024 20:15
@NewJerseyStyle NewJerseyStyle requested a review from patcon October 17, 2024 20:16
@NewJerseyStyle
Copy link
Member

Assigned @patcon as reviewer, assuming @thomassth wants to help in patcon's branch

@thomassth
Copy link
Author

I'm still confused which branch are we working on right now

@NewJerseyStyle
Copy link
Member

Now I guess the edge branch we used to use has been renamed as edge-civictechto but all description in documents were not updated so everyone was confused.

@thomassth thomassth changed the title Participation a11y Fix: open participation page accessibility issues Oct 18, 2024
@thomassth thomassth changed the title Fix: open participation page accessibility issues Fix: open participation page accessibility issues (Axe) Oct 18, 2024
@patcon
Copy link
Member

patcon commented Oct 18, 2024

Ah I'm sorry! that was my fault for changing it without checking for docs to update 😞

As I was doing it, I was wishing we had a PR-based way to edit settings, so the setings change could be discussed like a clear code change. I've used this on other projects: https://github.com/repository-settings/app (repo config-as-code)

But respectfully, I think this situation (accidentally pushing extra commits upstream) is kinda unrelated to what I did, no? we can't submit PR feature branches to upstream that have been branched off our active (and different) edge branch (whether we call it edge or edge-civictechto or whatever). Yes, I tried to clean up our commits in edge, but i believe someone immediately pushed the old commits back onto it? and avoiding that situation is at the core of what we need to resolve about this in our workflow, i think? (If I'm misunderstanding, I apologize!)

Regardless, sorry for generating an extra layer of confusion around something that was already confusing...! Appreciate y'all!

@patcon
Copy link
Member

patcon commented Oct 18, 2024

For now:

  1. I merged the remote tracking branch remote/civictechto/edge into our edge-civictechto
  2. I merged edge-civictechto into this feature branch

So now this PR is clean again 🎉

{{s.TOS}}
</a>
</a>
Copy link
Member

Choose a reason for hiding this comment

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

nit: pls revert (will explain later)

Comment on lines +12 to +13
"
>{{s.privacy}}</a>
Copy link
Member

Choose a reason for hiding this comment

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

nit: pls revert (will explain later)

@@ -8,7 +8,7 @@ class Button extends React.Component {
this.props.handleCurateButtonClick(this.props.identifier)
}

render () {
render() {
Copy link
Member

Choose a reason for hiding this comment

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

nit: pls revert (will explain later)

color: (!_.isNull(this.props.selectedTidCuration) && this.props.selectedTidCuration === this.props.identifier) ? "rgb(255,255,255)" : "rgb(100,100,100)",
borderRadius: 4,
}}
onClick={this.handleClick.bind(this)}>
onClick={this.handleClick.bind(this)}>
Copy link
Member

Choose a reason for hiding this comment

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

nit: pls revert (will explain later)

@patcon
Copy link
Member

patcon commented Oct 18, 2024

No no it's my fault. I was absent this week (had a bad mental health week, and needed to step back). I'll process your message and respond in the issue specifically about branching to keep things on-topic here :)

@NewJerseyStyle
Copy link
Member

We can see, and I am sure people are happy to offer assist for mental issues (hiking, walking, talking etc.) if we know how @patcon

On the other hand, let me organize the events related to branches

  1. One day patcon proposed that we should have a branch to keep track upstream, edge was proposed to do the job
  2. And I proposed that we should use dev branch to merge all PRs before merge to main, dev was proposed to do the job
  3. Some members told me edge should be where we keep the latest development
  4. We (patcon wasn't there) agreed to use edge to track the latest development of all sources (from compdemocracy/polis and from PRs of our member) to keep things easy to manage
  5. dev is merged into edge
  6. edge is merged into main
  7. all PRs merge to edge
  8. edge is renamed to edge-civictechto
  9. We are confused
  10. Here, now, this thread. It seems we had different expectation about what edge should be. So can you review and verify my understanding mentioned in above comment? 🙏 thanks

@patcon
Copy link
Member

patcon commented Oct 18, 2024

For others: I responded back in #35

@patcon
Copy link
Member

patcon commented Oct 18, 2024

FYI, when I tried to merge yesterday to made this PR cleaner, the upstream PR got messier: compdemocracy#1821 (I don't think we can do PRs to both with one branch in our current flow)

@NewJerseyStyle NewJerseyStyle merged commit f52620d into edge-civictechto Oct 18, 2024
1 of 5 checks passed
@NewJerseyStyle
Copy link
Member

NewJerseyStyle commented Oct 18, 2024

I am not sure what do you mean by messier, to me the issue would be github action script, everything else doesn't kill anyone so they can be resolved easily somehow

@NewJerseyStyle
Copy link
Member

After fixing branching issues, E2E test for the merge of this PR reported failure. I created another issue for it: #39

@Zen-cronic
Copy link
Collaborator

heh ok, i didn't go straight to the end, but the ideal contributor etiquette is to not let your editor make a bunch of noisy changes that are not actually what you are asking to get in, and make review as clean and small and simple as it can be for maintainers :)

...
If you have a codestyle change or cleanup you want to get into the codebase, I'd suggest doing that in one go, and having a PR and separate review specifically for all those fixups. Fixing them up on the fly in unrelated PRs is often not considered as helpful as it might appear, esp on a project like polis where PRs need to be really clean and in-scope

Agree, we appreciate your effort and contribution @thomassth, but clean PRs get reviewed and merged relatively faster in FOSS! also it's easier to spot actual code changes and bugs that way.

@thomassth
Copy link
Author

I was gonna rebase & clean it up the linting after work, but it got merged already!

Since this is merged, I'll reuse my branch to fix up the upstream PR (just realized I didn't open it in my own account 🙈)

imo we should have a linting default, but it's not a must. And we do that, we probably should do a cleanup in a separate styling PR before enforcing such things.

@NewJerseyStyle
Copy link
Member

I see. Sorry to merge it too soon after fixing branching problem.

And the Lint and other checks defined in GitHub Action was not triggered on the new branch name, I am fixing them

@thomassth thomassth mentioned this pull request Oct 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment