Design System Hub participates to the Hacktoberfest 2024! 🎉

[friedrith]

The Hacktoberfest is an opportunity to boost the impact of DesignSystemHub.

Concept

If you just discovered DesignSystemHub, there are 2 pages that can help you understand the concept:

• Wiki
• Concept

Scope of Hacktoberfest

DesignSystemHub is a great, young but large and ambitious project and since Hacktoberfest is very short, it has been decided to focus the effort on one small sub-project for Hacktoberfest: the React component detector, node-react-parser.

This parser aims to detect all the react components in the code. This tool is really important for DesignSystemHub because it will help achieve the goal of a zero-config tool, which is the opposite of a storybook where you need to write story files.

The first version has already been implemented and works very well. It is embedded in the node-cli. But the new version of the parser with more tests is in preparation in the folder packages/node-react-parser.

How to contribute

The goal for you is to increase the coverage of this new parser by:

1. read the contributing file
2. add new react component use cases: use your best imagination to create components in the fixture folder. You can either create a single file in the folder all-use-cases or full react projects directly in the fixture folder. If you don't have ideas, don't worry some use cases are already added and just require implementation, you can search for the expression TODO [Hacktoberfest] in the repository.
3. add unit tests using this fixture in the file tests/react-ast.test.ts
4. use the typescript compiler API in the file react-ast.ts to detect this new way to write a react component.
5. push a PR
6. ask for tag hacktoberfest-accepted
7. wait for your PR to be approved and merged

Depending on the size of your changes, consider posting an issue before, to collaborate with the maintainers.