Skip to content

Latest commit

Β 

History

History
242 lines (156 loc) Β· 5.1 KB

CONTRIBUTING.md

File metadata and controls

242 lines (156 loc) Β· 5.1 KB

Contributing to React Open Source 🀝

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.


πŸš€ Getting Started

1. Fork the Repository

Click the Fork button on the GitHub repository to create your own copy of the project.

2. Clone Your Fork

git clone https://github.com/YOUR-USERNAME/react-open-source.git

3. Enter the Project

cd react-open-source

4. Install Dependencies

npm install

5. Start the Development Server

npm run dev

🌿 Create a Branch

Please do not work directly on the main branch.

Create a separate branch for your contribution:

git checkout -b feature/your-feature-name

Examples:

git checkout -b feature/navbar
git checkout -b feature/dark-mode
git checkout -b fix/mobile-layout

Use a descriptive branch name that clearly explains the purpose of your changes.


πŸ’» Make 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.


πŸ§ͺ Test Your Changes

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 lint

Start the project locally with:

npm run dev

πŸ“ Commit Messages

Please 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 feature
  • fix: β€” Bug fix
  • docs: β€” Documentation changes
  • refactor: β€” Code refactoring
  • style: β€” Styling or formatting changes
  • chore: β€” Maintenance tasks

πŸ“€ Push Your Changes

Push your branch to your forked repository:

git push origin feature/your-feature-name

πŸ”„ Create a Pull Request

After 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

πŸ“‹ Pull Request Checklist

Before submitting your Pull Request, make sure:

  • I created a separate branch.
  • I tested my changes locally.
  • I ran npm run lint successfully.
  • 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.

πŸ› Reporting Bugs

When reporting a bug, please provide:

  1. A clear description of the issue.
  2. Expected behavior.
  3. Actual behavior.
  4. Detailed steps to reproduce the issue.
  5. Browser and operating system information.
  6. 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.


πŸ’‘ Suggesting Features

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.

🏷️ Good First Issues

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.


🀝 Community Guidelines

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

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! πŸš€