Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (35 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

56 lines (35 loc) · 1.35 KB
Raw

👋 Contributing to solancn-ui

Hello everyone! Thank you for showing interest in contributing to solancn-ui. Follow the steps below to get started:

🛠️ Getting Started

  1. Fork the Repository First, fork this repository to your own GitHub account.

  2. Clone Your Fork

    git clone https://github.com/BunsDev/solancn-ui
cd solancn-ui

  3. Install Dependencies

    npm install

  4. Start the Development Server

    npm run dev

🧹 Adding or Contributing a Component

If you want to add a new component or contribute to an existing one:

  1. Navigate to the app/ folder.

  2. Inside app/, go to the components/ folder. Every folder inside components/ is a component.

  3. Create a new folder for your component and add your files. ✅ Make sure your component is unique — do not copy others.

  4. After adding your component, go to the constants/ folder.

  5. Inside it, open navigation.ts.

  6. Register your component there to make it appear in the sidebar.

That’s it! 🎉

😟 A Few Guidelines

  • Use clean and readable code.
  • Write meaningful commit messages.
  • Test your component before submitting a pull request.
  • Don't forget to open a pull request from your fork when you're ready!

Happy Coding 💙 Thanks for contributing to Solancn UI!