diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..cb4a104 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,26 @@ +This repository follows a fork model for contributions per: + +https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project + + +Example workflow: + +1. Create a fork of repo as github user. +2. Checkout the forked copy from your personal github account, e.g.: + + git clone git@github.com:demo-contributing-user/singlestoredb-dev-image.git + +3. Create a development branch: + + # cd singlestoredb-dev-image + # git branch example-contribution + # git checkout example-contribution + +4. Make and commit changes to your local repository and push upstream: + + # git add CONTRIBUTING.md + # git commit -m "adding a contribution file" + # git push . + +5. Submit your code upstream. A designated repository owner will review and + provide feedback or merge your contribution