Skip to content

Latest commit

 

History

History
153 lines (105 loc) · 5.16 KB

CONTRIBUTING.MD

File metadata and controls

153 lines (105 loc) · 5.16 KB
Raw

Next UI Contributing Guide

Hello!, I am very excited that you are interested in contributing with Next UI. However, before submitting your contribution, be sure to take a moment and read the following guidelines.

Pull Request Guidelines

  • The main branch is basically a snapshot of the latest stable version. All development must be done in dedicated branches.
  • Make sure that Github Actions are green
  • It is good to have multiple small commits while working on the PR. We'll let GitHub squash it automatically before the merge.
  • If you add a new feature:
    • Add the test case that accompanies it.
    • Provide a compelling reason to add this feature. Ideally, I would first open a suggestion topic and green it before working on it.
  • If you correct an error:
    • If you are solving a special problem, add (fix #xxxx [, # xxx]) (# xxxx is the problem identification) in your PR title for a better launch record, for example update entities encoding / decoding (fix # 3899).
    • Provide a detailed description of the error in the PR. Favorite live demo.
    • Add the appropriate test coverage, if applicable.

Development Setup

After cloning the repository, execute the following commands in the root folder:

  1. Install dependencies
yarn

#or

yarn install

We use Turbo Repo for the project management.

  1. If you will be working on the components source code, you can use the following command to start the webpack dev server:
## Start the dev babel server of NextUI core components
yarn dev:nextui

## optional
yarn dev:docs ## this will start the documentation next.js server and it will automatically detect the changes in the components.

yarn start:sb ## this will start the storybook server for a faster development and testing.
  • If you will be working just on the documentation source code / mdx, you can use the following commands to build NextUI components and then start the next.js dev server:
## Build NextUI source components
yarn build:nextui

## Start the next.js documentation dev server
yarn dev:docs
  • You also can use Storybook to test the components and faster development:
yarn sb

#or

yarn start:sb

Remember that these commands must be executed in the root folder of the project.

  1. Create a branch for your feature or fix:
# Move into a new branch for your feature
git checkout -b feat/thing
# Move into a new branch for your fix
git checkout -b fix/something
  1. If your code passes all the tests, then push your feature/fix branch:

All commits that fix bugs or add features need a test. You can run the nest command for component specific tests.

# Test current code
yarn test:update # or npm run test:update

# Test isolated component code
yarn test src/button  # or npm run test src/button
  1. Be sure the package builds.
# Build current code
yarn build # or npm run build

Note: ensure your version of Node is 14 or higher to run scripts

  1. Send your pull request:
  • Send your pull request to the main branch
  • Your pull request will be reviewed by the maintainers and the maintainers will decide if it is accepted or not
  • Once the pull request is accepted, the maintainers will merge it to the main branch

Visual Changes

When making a visual change, please provide screenshots and/or screencasts of the proposed change. This will help us to understand the desired change easier.

Until NextUI has a stable release new components will be created only for the core team.

Documentation

Please update the docs with any API changes, the code and docs should always be in sync.

The main documentation lives in the apps/docs/content folder, the project uses MDX and all NextUI are already imported.

Breaking changes

Breaking changes should be accompanied with deprecations of removed functionality. The deprecated APIs themselves should not be removed until the minor release after that.

Becoming a maintainer

If you are interested in becoming a NextUI maintainer, start by reviewing issues and pull requests. Answer questions for those in need of troubleshooting. Join us in the Discord Community chat room. Once we see you helping, either we will reach out and ask you if you want to join or you can ask one of the current maintainers to add you. We will try our best to be proactive in reaching out to those that are already helping out.

GitHub by default does not publicly state that you are a member of the organization. Please feel free to change that setting for yourself so others will know who's helping out. That can be configured on the organization list page.

Being a maintainer is not an obligation. You can help when you have time and be less active when you don't. If you get a new job and get busy, that's alright.