Contribution Guide

This guide will instruct you on how to contribute to the Yida Developer Center. We provide two collaboration solutions: Issues and Pull Request:

Issues

We use GitHub Issues for developer center issue tracking. If you find problems in the documentation, you can submit an issue using the following template. We will periodically review and correct the documentation:

- Problem documentation link: https://yida-developer.gitee.io/docs/api/yidaAPI;
- Problem description: Description of this.setState() is incorrect, setState does not support callback functions;
- Recommended fix: Remove the callback usage in setState API;

Before you report an issue, please make sure you have searched existing issues.

Pull Request

We more recommend that you help us collectively improve the Yida Developer Center through Pull Request. Users can directly click the Edit this page button at the bottom of each document to quickly participate in document collaboration. The specific steps are as follows:

• Click Edit this page to enter the github page (if you don't have a github account, you need to register one);

• Fork the developer center repository code to your personal github space (only needs to be done once, subsequent modification requests will skip this step):

• Enter the document modification page to correct the document and submit the modification:

• Confirm the modification content and submit Pull Request:

At this point, a simple Pull Request has been completed. The Yida team will monitor all Pull Requests. We will review and merge your modifications, and may also ask you to make some modifications or tell you why we cannot accept such modifications. We will release a patch version from master weekly.

tip

Developers can also directly fork the developer center repository code locally for document editing and submit Pull Request. If you are still unclear about how to submit a Pull Request on GitHub, you can read the following article to learn:

How to contribute code gracefully on GitHub

The main branch we maintain is master, so please submit Pull Request to master.

tip

If developers need to submit new document content, they need to briefly describe the background and usage scenarios in the Pull Request, so that we can check and add.

Local Development Process

The Yida Developer Center is a developer platform built through Docusaurus 2. After you clone the code of the developer center and install dependencies with npm install, you can also run the following common commands:

Local Start

$ npm start

After starting, we can access it locally through http://localhost:3000/.

P.S.: Global search is not effective when running locally.

Build

$ npm run build

Build artifacts will be output to the build directory.

Local Real Preview

$ npm run serve

This command must be run after completing npm run build. It will start a static service locally based on the build directory, accessible through http://localhost:3000/. The effect is completely consistent with online effects and supports global search functionality.