We are committed to building an open source, neutral, powerful, and community ecologically prosperous scaffolding tool in the cloud-native era. The community welcomes external users to participate in community construction!
Before contributing, please take a moment to understand the process of contributing to cloud-native-app-initializer.
We welcome any contribution at any time, whether it's a simple typo fix, bug fix, or new feature addition. Feel free to ask questions or initiate PRs. We also value documentation and integration with other open source projects, and welcome contributions in this regard.
If it is a more complex modification, it is recommended to add a Feature flag to the Issue first, and briefly describe the design and modification points.
- Click the Fork icon in the upper right corner of this project to fork alibaba/cloud-native-app-initializer to your own space.
- Clone the cloud-native-app-initializer warehouse under your own account to the local, such as the steverao of my account, that is to execute git clone https://github.com/steverao/cloud-native-app-initializer.git to clone operate.
- Execute git config --list on your own machine to view the global username and mailbox of git.
- Check if the displayed user.name and user.email match your github username and email.
- If the company has its own gitlab or uses other commercial gitlabs, there may be a mismatch. At this time, you need to set the username and email address separately for the cloud-native-app-initializer project.
- For how to set user name and email address, please refer to github official documentation, set user name, set email address.
After forking the code, a new submission may appear in the Master branch of the original warehouse. At this time, in order to avoid conflicts between the submitted PR and the submission in Main, it is necessary to merge the Main branch in time.
As a Spring-related project, it directly follows the Spring Cloud project specification in terms of back-end code specification. Please refer to the relevant [code format specification description](https://github.com/spring-cloud/spring-cloud- build#checkstyle) , you need to configure the code format specification before submitting the code.
Develop your own functions. After the development is complete, it is recommended to use the mvn clean install command to ensure that the modified code can be compiled locally. While executing this command, the code can be automatically formatted in the way of spring. Then submit the code
Similarly, before submitting a PR, you need to rebase the code of the master branch. For specific steps, please refer to the previous chapter. If conflicts arise, they need to be resolved first.
Submit a PR, specify the modification points and implemented functions according to the Pull request template, wait for code review and merge, become a Cloud Native App Initializer Contributor, and work together for better scaffolding!