Open Source Contributions

Nayan UI is an open source project and we welcome contributions from the community. Whether you're fixing bugs, adding features, or improving documentation, every contribution matters!

50+
Components
100+
Contributors
500+
Pull Requests
MIT
License

Ways to Contribute

Report Bugs

Found a bug? Help us improve by reporting issues with detailed reproduction steps.

Good First Issue

Suggest Features

Have an idea for a new component or feature? Share your suggestions with the community.

Enhancement

Write Code

Contribute code by fixing bugs, implementing features, or improving existing components.

Code

Improve Docs

Help improve documentation, add examples, or fix typos to help other developers.

Documentation

Help Others

Answer questions, help with issues, and support fellow developers in the community.

Community

Spread the Word

Share Nayan UI with others, write blog posts, or create tutorials to grow our community.

Advocacy

Getting Started

1

Fork the Repository

Start by forking the Nayan UI repository on GitHub to your own account.

2

Clone & Setup

Clone your fork and install dependencies:

git clone https://github.com/your-username/nayan.git
cd nayan
yarn install
3

Create a Branch

Create a new branch for your changes:

git checkout -b feature/your-feature-name
4

Make Changes

Make your changes, add tests if needed, and ensure everything works properly.

5

Submit Pull Request

Push your changes and create a pull request with a clear description of your changes.

Development Guidelines

Component Guidelines

  • • Follow the existing component structure and naming conventions
  • • Include TypeScript types for all props and interfaces
  • • Add comprehensive documentation and examples
  • • Ensure components work in both React and React Native
  • • Include accessibility features (ARIA labels, keyboard navigation)
  • • Write unit tests for new components and features
  • • Follow responsive design principles

Pull Request Guidelines

  • • Provide a clear and descriptive title
  • • Include a detailed description of changes
  • • Reference related issues using #issue-number
  • • Add screenshots for UI changes
  • • Ensure all tests pass
  • • Keep pull requests focused and atomic
  • • Be responsive to code review feedback

Community & Support

Join Our Community

GitHub Repository
Discord Community (Coming Soon)

Recognition

We value every contribution! Contributors are recognized in:

  • • GitHub contributors list
  • • Release notes and changelogs
  • • Project documentation
  • • Social media shoutouts

Ready to Contribute?

Join our growing community of developers and help make Nayan UI better for everyone!