diff --git a/HACKTOBERFEST.md b/HACKTOBERFEST.md new file mode 100644 index 000000000..f5896e7ec --- /dev/null +++ b/HACKTOBERFEST.md @@ -0,0 +1,48 @@ +# Welcome to ReactPlay for Hacktoberfest! + +Thank you for joining the ReactPlay open-source community during Hacktoberfest 2025! 🎉 + +ReactPlay is an open-source web app designed to help you learn ReactJS through hands-on projects. Whether you're here to learn, create, or contribute, your participation is valuable. + +## Important Points for Hacktoberfest Contributors + +- **How to Contribute** + - Fork the `react-play` repository. + - Clone your fork locally and set up the project for development. + - Create or improve ReactJS projects called "Plays" and share your code. + - Follow the [`CONTRIBUTING.md`](./CONTRIBUTING.md) for guidelines and the code review process. + - Ensure your pull requests are meaningful, respectful, and adhere to coding standards. + - Run linting and tests as described in the contribution guide before submitting your PR. + +- **Environment Setup** + - Use Node.js version 16.x or higher. + - Install dependencies using `yarn install` (recommended) or `npm install`. + - Start the app locally with `yarn start` or `npm start` for live development. + +- **Code Quality** + - The project runs ESLint and formatting checks automatically. + - Fix any lint errors with `yarn run lint:fix` or `npm run lint:fix`. + - Format your code using `yarn run format` or `npm run format`. + - Pull requests with lint errors may not be reviewed or accepted. + +- **Getting Help** + - Check the issues to find new feature requests or bugs to work on. + - Ask questions or request help via GitHub issues or the ReactPlay community channels. + - Read the official ReactPlay [docs](https://docs.reactplay.io) and Watch the [YouTube guide](https://www.youtube.com/watch?v=h8suY-Osn8Q) for repository management. + +- **Rewards and Recognition** + - Your contributions will be recognized publicly and you can claim special ReactPlay badges. + - Show your ReactPlay badges with pride to inspire others. + +## Quick Links + +- [ReactPlay Demo](https://reactplay.io) — Explore the app live +- [Contribution Guide](./CONTRIBUTING.md) — Learn how to contribute the right way +- [Code of Conduct](CODE_OF_CONDUCT.md) — Our community values +- [Claim Your Hacktoberfest Reward Badge](https://aviyel.com/projects/43/reactplay/rewards) + +Let's learn, create, and grow together with ReactPlay! + +Happy Hacktoberfest and happy coding! + +