diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..4b013c63d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,26 @@ +# Fork +Fork sealos to your repository. `https://github.com//sealos` +# Clone +Clone `https://github.com//sealos` your own repository to develop locally. +# Set remote upstream +``` +git remote add upstream https://github.com/fanux/sealos.git +git remote set-url --push upstream no-pushing +``` +# Fetch from upstream +Merge fanux/sealos to `/sealos` +``` +git pull upstream master +git push +``` + +Merge `/sealos` to fanux/sealos just using github Pull requests. + +# Workflow +``` + Pull request + upstream(fanux/sealos)<-------------------------origin(/sealos) + | ^ + | pull upstream master push | + +---------------------->localGit---------+ +```