Contribution Step

First of all, I would like to thank everyone who is willing to participate in the contribution of the community. cloudrec community can become better with everyone's participation!!! This document uses the cloudrec project as an example to describe how to submit code contributions to the cloudrec project. Other projects are similar.

Fork Project

1. In order to contribute to the cloudrec project, you need to "Fork" the cloudrec project first and click the "Fork" button on the project page.
2. Clone the project after your Fork to the local development environment. The command is as follows: remember to put the user name <YOUR-GITHUB-USERNAME> replace it with your actual user name.

Construction of development environment

See Development Guide

Create a new branch and complete code development

1. To create a new branch, the command is as follows:
2. Please put <branch-name> replace with the actual branch name.
3. Modify code
4. Modify or add necessary documents
5. Modify or add necessary unit tests
6. Execute unit tests
7. Add Change File

git add xxxx

8. Submit your changes

git commit -m "feat: Add some Resources"

9. Submit a locally developed branch to a remote repository.

git push origin `<branch-name>`

Please put <branch-name>replace with the actual branch name.

Submitted by PR

1. Navigate to the Github repository page you cloned.
2. Click the "New pull request" button.
3. Select the branch commit PR that you just committed to the remote repository.
4. Add necessary information according to PR Template
5. Wait for the review of the maintenance member and provide the necessary feedback.

Others
Please feel free to contact us if you have any questions, we are very willing to provide you with necessary help!