Contribute

Help improve React Pluggable Layouts by contributing code, reporting issues, or sharing your projects

Ways to Contribute

Code Contributions

Submit pull requests to help improve the library's features, fix bugs, or enhance documentation.

Learn More

Issue Reporting

Report bugs, suggest features, or provide feedback to help improve the library.

Learn More

Documentation

Help improve our documentation by fixing errors, adding examples, or writing tutorials.

Learn More

Showcase Submission

Share your projects built with React Pluggable Layouts to inspire others.

Learn More

Code Contributions

Setting Up the Development Environment

  1. Fork the repository on GitHub
  2. Clone your fork locally
  3. Install dependencies with npm install
  4. Run tests with npm test

Pull Request Process

  1. Create a new branch for your feature or bugfix
  2. Make your changes, following our coding standards
  3. Add or update tests as necessary
  4. Update documentation to reflect any changes
  5. Submit a pull request with a clear description of the changes
# Clone your fork
git clone https://github.com/YOUR-USERNAME/react-pluggable-layouts.git
cd react-pluggable-layouts

# Create a branch
git checkout -b feature/your-feature-name

# After making changes
npm test
npm run build

# Commit and push
git add .
git commit -m "Add some feature"
git push origin feature/your-feature-name

Issue Reporting

How to Report Issues

Before submitting an issue, please check if a similar issue already exists. If you're experiencing a bug, please include:

  • A clear description of the bug
  • Steps to reproduce
  • Expected behavior
  • Actual behavior
  • Version information (React, React Pluggable Layouts, browser, etc.)
Report an Issue

Documentation

Improving Documentation

Our documentation is a crucial part of the project. You can help by:

  • Fixing typos or clarifying explanations
  • Adding examples or use cases
  • Creating tutorials or walkthroughs
  • Improving API documentation

The documentation source files are located in the docs directory of the repository.

View Documentation Source

Showcase Submission

Share Your Project

Have you built something with React Pluggable Layouts? We'd love to feature it in our showcase!

Submission Requirements:

  • Project name and description
  • Screenshots or demo link
  • Short explanation of how you used React Pluggable Layouts
  • Link to source code (if open source)
  • Your name and contact information

Send your submission to showcase@example.com or open a GitHub issue with the "showcase" label.

Submit to Showcase

Join Our Community

Get involved with the React Pluggable Layouts community. Ask questions, share ideas, and collaborate with other developers.