logoAnt Design

⌘ K
  • Design
  • Development
  • Components
  • Blog
  • Resources
5.25.4
  • Ant Design of React
  • Changelog
    v5.25.4
  • Basic Usage
    • Getting Started
    • Usage with Vite
    • Usage with Next.js
      Updated
    • Usage with Umi
    • Usage with Rsbuild
    • Usage with Farm
    • Usage with Refine
  • Advanced
    • Customize Theme
    • CSS Compatible
    • Server Side Rendering
    • CSS Variables
      New
    • Use custom date library
    • Internationalization
    • Common Props
    • React 19 Compatibility
      New
  • Migration
    • V4 to V5
    • Less variables to Component Token
  • Other
    • Third-Party Libraries
    • Contributing
    • FAQ
Code of Conduct
Open Development
Branch Organization
Bugs
Proposing a Change
Your First Pull Request
Sending a Pull Request
Development Workflow
Run locally
Checks the code style
Run test
Compile
Build
Development Tools
Being a collaborator

Contributing

contributors
  • Third-Party LibrariesFAQ

    Resources

    Ant Design X
    Ant Design Charts
    Ant Design Pro
    Pro Components
    Ant Design Mobile
    Ant Design Mini
    Ant Design Web3
    Ant Design Landing-Landing Templates
    Scaffolds-Scaffold Market
    Umi-React Application Framework
    dumi-Component doc generator
    qiankun-Micro-Frontends Framework
    Ant Motion-Motion Solution
    China Mirror 🇨🇳

    Community

    Awesome Ant Design
    Medium
    Twitter
    yuque logoAnt Design in YuQue
    Ant Design in Zhihu
    Experience Cloud Blog
    seeconf logoSEE Conf-Experience Tech Conference

    Help

    GitHub
    Change Log
    FAQ
    Bug Report
    Issues
    Discussions
    StackOverflow
    SegmentFault

    Ant XTech logoMore Products

    yuque logoYuQue-Document Collaboration Platform
    AntV logoAntV-Data Visualization
    Egg logoEgg-Enterprise Node.js Framework
    Kitchen logoKitchen-Sketch Toolkit
    Galacean logoGalacean-Interactive Graphics Solution
    xtech logoAnt Financial Experience Tech
    Theme Editor
    Made with ❤ by
    Ant Group and Ant Design Community

    The following is a set of guidelines for contributing to Ant Design. Please spend several minutes reading these guidelines before you create an issue or pull request.

    Code of Conduct

    We have adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

    Open Development

    All work on Ant Design happens directly on GitHub. Both core team members and external contributors send pull requests which go through the same review process.

    Branch Organization

    According to our release schedule, we maintain two branches, master and feature. If you send a bugfix pull request, please do it against the master branch, if it's a feature pull request, please do it against the feature branch.

    Bugs

    We are using GitHub Issues for bug tracking. The best way to get your bug fixed is by using our issue helper and provide reproduction steps with this template.

    Before you report a bug, please make sure you've searched existing issues, and read our FAQ.

    Proposing a Change

    If you intend to change the public API or introduce new feature, we also recommend you use our issue helper to create a feature request issue.

    If you want to help on new API, please reference API Naming Rules to name it.

    Your First Pull Request

    Working on your first Pull Request? You can learn how from this free video series:

    How to Contribute to an Open Source Project on GitHub

    To help you get your feet wet and get you familiar with our contribution process, we have a list of good first issues that contain bugs or small features that have a relatively limited scope. This is a great place to get started.

    If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don't accidentally duplicate your effort.

    If somebody claims an issue but doesn't follow up for more than two weeks, it's fine to take over it but you should still leave a comment.

    Sending a Pull Request

    The core team is monitoring for pull requests. We will review your pull request and either merge it, request changes to it, or close it with an explanation.

    Before submitting a pull request, please make sure the following is done:

    1. Fork the repository and create your branch from the correct branch.
    2. Run npm install in the repository root.
    3. If you've fixed a bug or added code that should be tested, add tests!
    4. Ensure the test suite passes (npm run test). Tip: npm test -- --watch TestName is helpful in development.
    5. Run npm test -- -u to update the jest snapshots and commit these changes as well (if there are any updates).
    6. Ensure the UI change passes npm run test:image, Run npm run test:image -- -u to update UI snapshots and commit these changes as well (if there are any updates), UI test base on Docker, need download the corresponding installation according to the platform
    7. Make sure your code lints (npm run lint). Tip: Lint runs automatically when you git commit (Use Git Hooks).
    8. Finally, please make sure that all GitHub CI checks pass, if they fail, you can click detail to enter the details to view the reason.

    Sending a Pull Request to react-component:

    Since antd's components are based on react-component, sometimes you may need to send pull request to the corresponding react-component repository. If it's a bugfix pull request, after it's merged, the core team will release a patch release for that component as soon as possible, then you only need to reinstall antd in your project to get the latest patch release. If it's a feature pull request, after it's merged, the core team will release a minor release, then you need raise another pull request to Ant Design to update dependencies, document and TypeScript interfaces (if needed).

    Development Workflow

    npm or yarn are recommended as package management tools.

    After you clone the antd code and use following commands to install dependencies:

    npm iconnpm
    yarn iconyarn
    bash
    $ npm install

    You can also run the following common commands:

    Run locally

    Runs Ant Design website locally.

    npm iconnpm
    yarn iconyarn
    bash
    $ npm start

    Checks the code style

    npm iconnpm
    yarn iconyarn
    bash
    $ npm run lint

    Run test

    runs the complete test suite. (Make sure the NODE_ENV environment variable is unset, or it may causing some problems.)

    npm iconnpm
    yarn iconyarn
    bash
    $ npm test

    Compile

    compiles TypeScript code to the lib and es directory.

    npm iconnpm
    yarn iconyarn
    bash
    $ npm run compile

    Build

    creates UMD build of antd.

    npm iconnpm
    yarn iconyarn
    bash
    $ npm run dist

    Development Tools

    • VSCode plugin for CSS in JS: https://marketplace.visualstudio.com/items?itemName=shezhangzhang.antd-design-token
    • Ant Design cheatsheet in VS Code: https://github.com/fi3ework/vscode-antd-rush

    Being a collaborator

    If you are an active contributor and are willing to work with Ant Design Team in our opensource workflow, you can apply to be a outside collaborator.

    You can also refer to the following contribution guide to become an antd contributor:

    • How to Grow as a Collaborator