2.2 KiB
Contributing to MaaAssistantArknights
-
If you have forked this repository before, please go to
Settings, scroll down to the bottom, and clickDelete Repository. -
Go to MAA main repository and click
Fork, thenCreate fork. -
Clone the
devbranch of the repository (of your account) to local:git clone "your git repo link" -b dev -
Configure development environment
- Download and install
Visual Studio 2022 Community. SelectDesktop development with C++and.NET Desktop Development.
- Download and install
-
Double-click to open the file
MeoAssistantArknights.sln. Visual Studio will load the project automatically. -
Run a build to test whether the development environment has been configured correctly. Chosse
Release&x64, right-clickMeoAsstGuito set it as the startup project, and run it. If the build is successful, theMeoAsstGuiwindow will appear. You can connect to the simulator in order to confirm again that the development environment has been configured correctly. -
Now you are free to contribute to MAA.
-
Remember to commit once you have proper number of changes. Don't forget to write a commit message.
-
After development, push your local changes to the remote (of your repository).
git push origin dev -
Go to MAA repository and submit a Pull Request. Wait until the administrator approves it. Please note that the changes should be based on
devinstead ofmasterbranch, and should be merged todevbranch as well. -
When there are changes from other contributors on original MAA repository, it is necessary for you to merge them to your forked repository.
-
Add MAA upstream repository.
git remote add upstream https://github.com/MaaAssistantArknights/MaaAssistantArknights.git -
Fetch upstream changes from the repository.
git fetch upstream -
Merge changes.
git merge -
Repeat step 7-10.
-
Note: operations regarding to Git can be done by VS2022 instead of command line tools, using the Git changes tab.