Thank you for your interest in contributing to React Open Source!
This project is designed to help developers learn React, improve their development skills, and gain practical experience with real-world open-source collaboration.
Contributions of all experience levels are welcome. Whether you are fixing a bug, improving the UI, adding a feature, or updating documentation, your contribution is appreciated.
Click the Fork button on the GitHub repository to create your own copy of the project.
git clone https://github.com/YOUR-USERNAME/react-open-source.gitcd react-open-sourcenpm installnpm run devPlease do not work directly on the main branch.
Create a separate branch for your contribution:
git checkout -b feature/your-feature-nameExamples:
git checkout -b feature/navbar
git checkout -b feature/dark-mode
git checkout -b fix/mobile-layoutUse a descriptive branch name that clearly explains the purpose of your changes.
Make your changes according to the issue or feature you are working on.
Please keep your code:
- Clean
- Readable
- Reusable
- Responsive
- Consistent with the existing project structure
Avoid making unrelated changes outside the scope of your contribution.
Before submitting a Pull Request, make sure that:
- The project runs successfully.
- There are no console errors.
- Existing functionality continues to work.
- Your changes work across different screen sizes where applicable.
- Your code follows the existing project structure and conventions.
- Linting passes successfully.
Run:
npm run lintStart the project locally with:
npm run devPlease use clear and meaningful commit messages.
Examples:
git commit -m "feat: add navbar component"git commit -m "fix: improve mobile responsive layout"git commit -m "docs: update contributing guide"Use prefixes such as:
feat:β New featurefix:β Bug fixdocs:β Documentation changesrefactor:β Code refactoringstyle:β Styling or formatting changeschore:β Maintenance tasks
Push your branch to your forked repository:
git push origin feature/your-feature-nameAfter pushing your changes, open your GitHub repository and create a Pull Request against the project's main branch.
Please provide:
- A clear and descriptive title.
- A summary of your changes.
- The related issue number.
- Screenshots or videos for UI changes.
- Any additional information that may help reviewers.
For example:
Closes #12
Before submitting your Pull Request, make sure:
- I created a separate branch.
- I tested my changes locally.
- I ran
npm run lintsuccessfully. - I checked for console errors.
- Existing functionality still works.
- I followed the project's coding standards.
- I wrote a clear commit message.
- I added screenshots or videos for UI changes where applicable.
- I linked the related issue.
- I reviewed my changes before submitting the Pull Request.
When reporting a bug, please provide:
- A clear description of the issue.
- Expected behavior.
- Actual behavior.
- Detailed steps to reproduce the issue.
- Browser and operating system information.
- Screenshots, videos, or error logs where applicable.
Before creating a new issue, please search existing issues to make sure the bug has not already been reported.
Before submitting a feature request, please check whether a similar request already exists.
A good feature request should explain:
- What feature you are proposing.
- Why the feature would be useful.
- How you expect it to work.
- Any alternative solutions you have considered.
- Relevant screenshots, mockups, or references.
If you are new to open-source development, look for issues labeled:
good first issue
These issues are intended to provide an accessible starting point for new contributors.
Please help maintain a respectful and welcoming environment:
- Be respectful to other contributors.
- Provide constructive feedback.
- Avoid offensive or discriminatory language.
- Be patient with beginners.
- Keep discussions focused on the project.
- Respect different opinions and approaches.
For more information, please read our Code of Conduct.
Thank you for taking the time to contribute to React Open Source!
Every contribution, whether large or small, helps improve the project and provides valuable learning opportunities for the community.
Happy Coding! π