Contribution

Git workflow

Git Merge workflow is our current development mode.

Contribute

1. Make sure you are in main branch and already update latest changes from origin/main.
   • git branch // See if you are main branch
   • git pull // Avoid you are behind origin/main
2. Create a new branch from main branch and checkout it.
   • git checkout -b feature // -b means create branch at first, then checkout
3. Make contributions and commit.
   • git add . // Please check if you missed something
   • git commit -m "add feature xxx"
4. Push feature branch to Github repo and create Pull Request.
   • If you are outside collaborator, please fork at first then push to origin.
   • If you are member of CatDogEngine, please directly push to this repo.
   • Create Pull Request from your branch to origin/main.
5. Wait Github Action build. It should be successful for all current support platforms.
6. Invite current active developers to help to have a code review.
7. CatDogEngine developer will help to squash and merge if your branch have a long history of commits. It is better if you can clean commits history by yourself!