[FastPR] FastPR Usage Process #911
Description
Description
FastPR is a feature designed to simplify the process of contributing to open source projects. Users can directly modify the content on the document page provided by the plug-in, and the plug-in will automatically generate and submit PR after completion, simplifying the contribution process. This feature not only supports GitHub, but can also be extended to other designated documentation sites.
The current configuration has been applied to the following websites:
- Open Source Software Overview Provides a comprehensive open source knowledge framework for practitioners, researchers, and enthusiasts in the open source field.
- OpenDigger An open source data analysis platform offering rich features for open source ecosystem insights and data analysis.
- Open Source Books A series of open source knowledge books authored by Kaiyuanshe, covering basic concepts, practical guides, and case studies in the open source domain.
- KaiwuDB Documentation Development documentation for KaiwuDB, offering guidance and instructions on database usage and development.
Websites Requiring Configuration
If there are additional documentation projects that require configuration, feel free to visit the HyperCRX project and submit an Issue. For non-profit projects, we offer free
The following is the user guide.
- The first step is to locate the plugin icon and click to enter the Settings page. In the GitHub Account Binding section, click the Bind Account button to be redirected to GitHub’s authorization page. On the page, log in to your GitHub account and authorize HyperCRX to access the required permissions. The same process applies to binding a Gitee account.
Once the account is successfully bound, the status will change from No binding account found to displaying the bound account information, indicating that the binding process is complete.
- The second step is to locate the corresponding icon of the plugin on the document page and click on it. This way, we will be able to see the original content of the document.
- The third step is to edit the document. Enter the content that needs to be modified on the left side of the page, and click the ✅ icon to save the changes after completing the edits.
- The fourth step is that a FastPR prompt will appear on the page. Click the Submit button to submit the changes. When the “PR created successfully” message appears, it means the PR has been successfully submitted to the repository.