GLEIF-IT · 2byrds · Nov 24, 2024 · Nov 22, 2024 · Nov 22, 2024 · Nov 22, 2024
diff --git a/docs/CONTRIBUTE.md b/docs/CONTRIBUTE.md
@@ -0,0 +1,66 @@
+# This is a rough guide for contributing to this repository
+
+* Create an issue with details of the change you want to make
+![Create issue](image-10.png)
+
+# Fork the repo into your own GitHub account
+* In your browser go to https://github.com/GLEIF-IT/vlei-verifier
+* Click the "Fork" button in the top right corner of the page
+* Fork the repo into your own GitHub account
+![Fork the repo](image-1.png)
+![Your fork](image-2.png)
+
+# Start from main
+* From your terminal or IDE, clone your forked repo
+```
+git clone https://github.com/2byrds/vlei-verifier.git
+```
+* Confirm you are starting from the main branch
+```
+git status
+```
+![Start from main](image.png)
+
+# Create new branch
+* Switch from main, creating a new branch [semantically named](https://gist.github.com/seunggabi/87f8c722d35cd07deb3f649d45a31082#file-semantic-branch-names-md) to something like 'docs/contrib_guide'
+
+```
+git switch -c "docs/contrib_guide"
+```
+![switch to new branch](image-3.png)
+
+# Add/Commit the changes to the branch
+* Git add your changes and commit them. Note that the -s flag signs the commit and the -S flag signs the commit with a GPG key. That is currently optional but preferred.
+```
+git add docs
+```
+![git add the files](image-4.png)
+
+```
+git commit -s -S -m"Added docs folder and CONTRIBUTE guide"
+```
+![commit changes to git](image-5.png)
+
+# Push the changes to your fork
+```git push 2byrds```
+![push changes to GitHub](image-6.png)
+
+# Create a pull request
+* Go to your forked repo in your browser
+* Click the "New pull request" button
+* Set the reviewer to 2byrds (or whoever you want to review your changes)
+* Add a title and description
+* Set yourself as the assignee
+* Under development, associate your PR with the issue you are working on
+* Click "Create draft pull request" until it is ready for final review
+* Click "Ready for review" when you are ready for the reviewer to look at the changes to be merged
+![Start PR from branch to main](image-7.png)
+![Title, description, assignee, etc](image-8.png)
+![Associate issue](image-9.png)
+
+# Go through review
+* Respond to the reviewers questions/comments/requests
+* Note there are several automated checks listed on the PR overview that must all pass
+
+# Merge and Issue update
+* Once approved the pull request will be merged and the issue can be updated/close
diff --git a/docs/image-1.png b/docs/image-1.png
diff --git a/docs/image-10.png b/docs/image-10.png
diff --git a/docs/image-2.png b/docs/image-2.png
diff --git a/docs/image-3.png b/docs/image-3.png
diff --git a/docs/image-4.png b/docs/image-4.png
diff --git a/docs/image-5.png b/docs/image-5.png
diff --git a/docs/image-6.png b/docs/image-6.png
diff --git a/docs/image-7.png b/docs/image-7.png
diff --git a/docs/image-8.png b/docs/image-8.png
diff --git a/docs/image-9.png b/docs/image-9.png
diff --git a/docs/image.png b/docs/image.png