Skip to content

Commit

Permalink
add new workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
hmellahi committed Dec 15, 2024
1 parent c24af9b commit a22ac8e
Showing 1 changed file with 59 additions and 0 deletions.
59 changes: 59 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,3 +94,62 @@ challenge-cli start twitter-like
# Example 2
challenge-cli start twitter-like my-solution
```

## How to Check if Your Solution (UI) Is Accessible

You can use automated accessibility checkers like **axe-core** to detect most accessibility issues.

For more information, check out [this article](https://larsmagnus.co/blog/how-to-test-for-accessibility-with-axe-core-in-next-js-and-react).

Also :

- Test your app with a keyboard to ensure full keyboard navigation
- Add ARIA labels to make your app understandable by screen readers
- Use [Claude](https://claude.ai/new) for a final accessibility check

> [!NOTE]
> axe-core is already included in the starter template.
## How can you help?

- ⭐️ Star this repository to motivate the addition of more challenges
- 🤓 Solved an interesting problem? Feel free to submit it!
- 🐞 If you find a bug, raise an issue or fix it and send a pull request.
- 📚 Improve documentation or add tutorials for solving challenges.

## How To Add Your Solution

To add your solution follow the process for [making a pull request to an open-source project](https://github.com/gabrieldemarmiesse/getting_started_open_source).

In short:

- Fork this repo and clone it.
- Create a branch and make your change.
- Push your branch to your fork.
- Open a PR against this repo.

## How To Add New Problem

If you wanna work with React, you can use the starter template.

if you can create a new problem, use the create command:

```bash

syntax: challenge-cli create $PROBLEM_NAME $PROJECT_NAME
# $PROJECT_PATH default value is 'problems'

# Example 1
challenge-cli create new-problem

# Example 2
challenge-cli create new-problem problems-folder

```

## Coding Standards

Please adhere to the following coding standards when submitting solutions:

- Ensure your app is accessible. Refer to the [Accessibility Guidelines](#how-to-check-if-your-solution-ui-is-accessible) for more details.
- Format your code using Prettier.

0 comments on commit a22ac8e

Please sign in to comment.