Skip to content

Latest commit

 

History

History
57 lines (39 loc) · 2.3 KB

LEARN.md

File metadata and controls

57 lines (39 loc) · 2.3 KB

Welcome to Web Componentify!

Web Componentify is a community-driven repository for sharing and discovering reusable web components across different frameworks and languages. This guide will help you get started with using and contributing to this project.

Table of Contents

Getting Started

Browsing Components

  1. Explore the Components directory to see available components.
  2. Components are organized by framework or language for easy navigation.
  3. Click on a component to view its details and usage instructions.

Using Components

  1. Choose a component that suits your project.
  2. Follow the provided usage instructions to integrate the component into your project.
  3. Provide feedback or report issues if you encounter any problems.

Contributing

We encourage contributions from the community to enrich our library of web components. Here's how you can contribute:

Creating a New Component

  1. Fork this repository to your GitHub account.
  2. In your forked repository, create a new directory for your component within the relevant framework or language folder.
  3. Develop and thoroughly test your component.
  4. Include a README.md in your component's directory with clear usage instructions.
  5. Add any necessary licensing information to your component's directory.
  6. Ensure your code follows best practices and is well-documented.

Submitting Your Component

  1. Open a Pull Request (PR) to submit your component to the main repository.
  2. In your PR, provide a detailed description of your component.
  3. Our community and maintainers will review your contribution.

Community Guidelines

  1. Be respectful and inclusive when interacting with fellow contributors.
  2. Provide constructive feedback and support to help maintain a positive community.

Code of Conduct

Please review our Code of Conduct to understand the standards and expectations we have for contributors in this community.

Happy componentizing!