Skip to content

Latest commit

 

History

History
88 lines (51 loc) · 2.72 KB

CONTRIBUTING.md

File metadata and controls

88 lines (51 loc) · 2.72 KB

Contributing to Livo

Thank you for considering contributing to Livo! To ensure a smooth contribution process, please follow these guidelines.

How to Contribute

  1. Fork the repository: Click the "Fork" button at the top right of this page to create your own copy of the repository.
  1. Create a new branch: Create a new branch in your forked repository for your changes. Use a descriptive name for the branch, e.g., feature/new-feature or bugfix/fix-issue.
   git checkout -b your-branch-name
  1. Make your changes: Implement your changes in your branch. Ensure that your code follows the project's coding standards and guidelines.
  1. Add new UI components: If you are adding new UI components, follow these steps:
  • Install shadcn/ui (if not already installed):
	npx shadcn-ui@latest init
  • Add new components using the CLI:
   npx shadcn-ui add <component-name>

Replace <component-name> with the name of the component you want to add (e.g., button, input, etc.).

  • Update Documentation:

    • README.md: Add details about the new components, including usage examples.
    • UI_COMPONENTS.md (if exists): Update with details of the newly added components.

  1. Commit your changes: Use clear and concise commit messages following this format:

    • Type: short description
    • Details: Detailed explanation of the changes made. Why were these changes necessary? What issue does it resolve? Include any relevant context.

    Example Commit Message

    chore: remove boilerplate code from Next.js starter template

    Removed default boilerplate code to start with a clean slate for project development.

  1. Push your changes: Push your changes to your forked repository.
   git push origin your-branch-name
  1. Create a Pull Request: Go to the original repository and click on "New Pull Request". Select your branch and submit the pull request. Provide a clear description of the changes you made and any additional context that might be helpful.

Coding Standards

  • Code style: Follow the project's coding style and conventions. Make sure your code is well-formatted and adheres to the guidelines provided in the project's documentation.
  • Testing: If applicable, write tests for your changes. Ensure that all existing tests pass before submitting your pull request.
  • Documentation: Update any relevant documentation if your changes affect the project’s functionality or usage.

Contact

If you have any questions or need assistance with the contribution process, feel free to contact me:

Email: nikd0e@yandex.ru Telegram: @nikdoe

Thank you for contributing to Livo!