Enhance Contribution Instructions for New Developers #34
Description
Description
The current setup instructions in the README may be overwhelming for new developers, especially those unfamiliar with Deno or Git submodules. To enhance contribution and onboarding, it's suggested to provide clearer guidance and perhaps a step-by-step checklist for setting up the project for the first time.
Suggested Improvements:
- Clarify the Deno installation step: Provide a link to the Deno installation guide and specify any Deno version requirements that may exist.
- Break down the setup process: Consider creating sections that explicitly outline each major step (Cloning the repo, installing dependencies, building packages, starting the test environment) with brief explanations or context.
- Common Issues: Add a section for common issues new contributors might face along with troubleshooting tips, e.g., problems related to Deno compatibility or submodule errors.
- Example Usage: Include a simple example of how to contribute to the design system, e.g., adding a new component, with links to further resources if necessary.
By implementing these changes, the project can lower the barrier to entry for new contributors, encouraging more community involvement and contributions.