Skip to content

Latest commit

 

History

History
65 lines (38 loc) · 2.99 KB

CONTRIBUTING.md

File metadata and controls

65 lines (38 loc) · 2.99 KB
Raw

Contributing to LangUI

Thank you for considering contributing to LangUI! We appreciate your support in making this open-source Tailwind UI library even better for the AI community. Whether you want to fix a bug, add new components, or improve the documentation, your contributions are valuable to us.

To contribute to LangUI, please follow these guidelines:

Getting Started

  1. Fork the Repository: Start by forking the LangUI repository to your GitHub account. This will create a copy of the repository under your account, allowing you to make changes.

  2. Clone the Repository: Clone the forked repository to your local machine using Git. Use the following command:

    git clone https://github.com/ahmadbilaldev/LangUI.git

  3. Install Dependencies: Ensure you have Node.js and npm installed. Run the following command in the project directory to install the required dependencies:

    npm install

  4. Run the Server: Run the local server using:

    npm run dev

Making changes

  1. Create a Branch: Before making any changes, create a new branch where you will work on your contribution. Use a descriptive and relevant name for your branch:

    git checkout -b your-branch-name

  2. Make Changes: Implement your changes, whether it's adding new components, fixing bugs, or improving existing code. All LangUI components go in the public/components directory.

  3. Build your Component's CSS: If you are building or making changes to a component, you will have to run the following command to build its CSS:

    npm run css:components

  4. Test Your Changes: Before submitting a pull request, ensure that your changes work as intended. Run tests if available and test the components in different viewports and modes.

  5. Commit and Push: Once you are satisfied with your changes, commit them using descriptive commit messages.

Submitting a Pull Request

  1. Create Pull Request: Go to your forked repository on GitHub and click on the "New Pull Request" button. Compare your branch with the main branch of the original repository.

  2. Describe Your Changes: Provide a clear and concise description of your changes in the pull request. Include any relevant information that helps reviewers understand your contribution.

  3. Review Process: The maintainers of LangUI will review your pull request. Be prepared for feedback and make any necessary adjustments based on the review.

  4. Merge: Once your pull request is approved, it will be merged into the main branch, and your changes will be part of LangUI!

License

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

Thank you for contributing to LangUI! We greatly appreciate your efforts to make this library even more valuable to the AI community. If you have any questions or need assistance, feel free to open an issue or reach out to the maintainers.

Happy contributing! 😊