Skip to content

codewithemma/react-components-library

Repository files navigation

Contributing to React Components Library

We welcome contributions to our project! By contributing, you help improve and grow our collection of React components. Follow the guidelines below to get started.

Table of Contents

  1. Code of Conduct
  2. How to Contribute
  3. Development Guidelines
  4. License

Code of Conduct

By participating in this project, you agree to abide by the Contributor Covenant Code of Conduct. Please read it to understand what is expected of all participants.

How to Contribute

Reporting Bugs

If you find a bug in the project, please open an issue on GitHub. Provide as much detail as possible, including:

  • A clear and descriptive title
  • Steps to reproduce the issue
  • Expected and actual results
  • Screenshots or code snippets, if applicable

Suggesting Features

We are always looking for new ideas to improve our project. If you have a feature request, please open an issue on GitHub. Include:

  • A clear and descriptive title
  • A detailed description of the feature
  • Any relevant examples or mockups

Submitting Pull Requests

To contribute code, follow these steps:

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/your-feature-name)
  3. Make your changes
  4. Commit your changes (git commit -m 'Add some feature')
  5. Push to the branch (git push origin feature/your-feature-name)
  6. Open a pull request

Please ensure your pull request adheres to the following guidelines:

  • Keep your changes focused on a single feature or bug fix.
  • Update the documentation as necessary.
  • Ensure your code passes existing tests and add new tests if applicable.

Development Guidelines

Setting Up the Project

To set up the project locally:

  1. Clone the repository: git clone https://github.com/your-username/random-react-components.git
  2. Navigate to the project directory: cd random-react-components
  3. Install dependencies: npm install
  4. Start the development server: npm start

Coding Standards

Running Tests

Before submitting a pull request, ensure all tests pass:

  1. Run the tests: npm test
  2. Add new tests for any new components or features.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.

Thank you for contributing to Random React Components!

About

A lightweight and customizable collection of prebuilt React components to help you build modern, responsive UIs quickly and efficiently.

Resources

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors