PR Contribution Process

Open Source Guide

1. Sync Fork from Upstream

Github Documentation: syncing-a-fork

To prevent conflicts caused by changes in the upstream repository, you should sync fork before making a pr, and resolve conflicts (try to resolve conflicts locally).

2. Sync from Remote Repository && Resolve Conflicts Locally

1. Use the git pull command locally to sync code from the remote repository

2. If there are no conflicts, that's great. If there are conflicts, refer to about-merge-conflicts to resolve them.

3. Commit && Push to Remote Repository

Code Formatting

Please use mvn spring-javaformat:apply to format your code before committing.

1. A pull request can only contain one commit. If there are multiple commits, use the Rebase command to merge commits
2. Each commit should add corresponding modification records in the CHANGELOG.
3. Ensure the commit message follows the Angular Commit Guidelines for proper formatting.
4. Use git push or git push -f(add -f if merging remote commits) to push commit to the remote repository.

• Reference document for Rebase operation

TIP

• Conventional Commits Specification
• Angular Commit Guidelines

4. Create Pull Request

1. Create a pull request

2. Fill in the title and comment carefully. The title briefly describes your intention, and the comment provides a detailed description of the process. You can refer to closed prs.

3. Handle reviews. If your pull request is perfect, it will be directly accepted by the community. If the community review finds issues, there will be comments, and we can discuss directly. After the issue is resolved, click Resolve conversation.

Note: If multiple commits occur during the problem-solving period, we need to use the rebase command to merge commits!