Merge pull request #2925 from Mbaoma/improve-dockerization

update CONTRIBUTING.md file to have a better formatting

CONTRIBUTING.md

@@ -1,17 +1,32 @@
 # How to Contribute
 
-We love to pull requests from everyone! We follow the standard Git workflow of `fork -> change -> pull request -> merge -> update fork -> change ... (repeat forever)`. If you are new to open source, we recommend GitHub's excellent guide on "[How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)". In addition, please feel free to reach out to any of the maintainers or other community members if you are struggling; we are here to help you learn!
+We love to pull requests from everyone! We follow the standard Git workflow of `fork -> change -> pull request -> merge -> update fork -> change ... (repeat forever)`.
 
-Before getting started, please make sure you've read the [README](README.md) to get a primer on our project. Augur's documentation can be found at: https://oss-augur.readthedocs.io/en/main/
+If you are new to open source, we recommend GitHub's excellent guide on "[How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)". In addition, please feel free to reach out to any of the maintainers or other community members if you are struggling as we are here to help you learn!
+
+Before getting started, please make sure you've read the [README](README.md) to get a primer on our project. Augur's documentation can be found [here](https://oss-augur.readthedocs.io/en/main/).
 
 ## Opening an issue
 If you're experiencing an issue with Augur or have a question you'd like help answering, please feel free to open an [issue](https://github.com/chaoss/augur/issues). To help us prevent duplicates, we kindly ask that you briefly search for your problem or question in our [issues](https://github.com/chaoss/augur/issues) before opening a new one.
 
-Please note that if you open a bug report and your issue does not follow our template, we cannot help you until you have provided us all the relevant information in that format. Respectfully, we do not have the time to try and recreate an error given with minimal or no context, so by providing this information you are helping us help you! You will see this template when you open an issue; click on "Bug Report" and it will be populated with descriptions of what to put in each section. Replace the descriptions with your comments to the best of your ability, and please include screenshots and error logs if applicable.
+Please note that if you open a bug report and your issue **does not** follow our template, we cannot help you until you have provided us all the relevant information in that format. 
+Respectfully, we do not have the time to try and recreate an error given with minimal or no context, so by providing this information you are helping us help you!
+
+### How to submit a bug report
+To see the template referred to in the above section, click on **New Issue**, then click on the **Get Started** button on the **Bug Report** option.
+A dialogue box populated with descriptions of what to put in each section, will pop up on a new page.
+Kindly replace the descriptions with your comments to the best of your ability, and please include screenshots and error logs if applicable.
+
+<img width="1563" alt="file1" src="https://github.com/user-attachments/assets/138e5c2e-2595-474c-9642-a48d4a6c5e1b">
+
+<img width="1563" alt="file2" src="https://github.com/user-attachments/assets/59604aa9-d283-4fb2-8220-f3e906e6a203">
+
+<img width="1524" alt="file3" src="https://github.com/user-attachments/assets/8f123c63-641f-4fe5-b28d-6c47ff19d1f1">
+
 
 ## Contributing to the source code
 
-1. Fork this repo, and then clone it:
+1. Fork and clone this repo:
 ```bash
 $ git clone github.com:your-username/augur.git
 $ cd augur/
@@ -35,45 +50,41 @@ $ git push -u origin my-new-branch
 ```
 6. Then, [submit a pull request](https://github.com/chaoss/augur/compare).
 
-At this point, you're waiting on us. We like to at least comment on pull requests
-within three business days (and, typically, one business day). Once one of our maintainers has had a chance to review your PR, we will either mark it as "needs review" and provide specific feedback on your changes, or we will go ahead and complete the pull request.
+At this point, you're waiting on us. We like to at least comment on pull requests within three business days (and, typically, one business day).
+Once one of our maintainers has had a chance to review your PR, we will either mark it as ```needs review``` and provide specific feedback on your changes, or we will go ahead and complete the pull request.
 
 ## Signing-off on Commits
-To contribute to this project, you must agree to the [Developer Certificate of Origin](https://developercertificate.org/) by the [CHAOSS charter](https://chaoss.community/about/charter/#user-content-8-intellectual-property-policy) for each commit you make. The DCO is a simple statement that you, as a contributor, have the legal right to make the contribution.
-To signify that you agree to the DCO for contributions, you simply add a line to each of your
-git commit messages:
+To contribute to this project, you must agree to the [Developer Certificate of Origin](https://developercertificate.org/) (DCO) by the [CHAOSS charter](https://chaoss.community/about/charter/#user-content-8-intellectual-property-policy) for each commit you make. The DCO is a simple statement that you, as a contributor, have the legal right to make the contribution.
+To signify that you agree to the DCO for contributions, you simply add a line to each of your git commit messages. For example:
+```
+Signed-off-by: Jane Smith <jane.smith@example.com>
+```
 
-  ```
-  Signed-off-by: Jane Smith <jane.smith@example.com>
-  ```
-This can be easily done by using the `-s` flag when using `git commit`. For example:
+This can be easily done by using the `-s` flag when running the `git commit` command,
 
 ```
 $ git commit -s -m “my commit message w/signoff”
 ```
+
 To ensure all your commits are signed, you may choose to [configure git](https://gist.github.com/xavierfoucrier/c156027fcc6ae23bcee1204199f177da) properly by editing your global ```.gitconfig```
 
 **Any pull requests containing commits that are not signed off will not be eligible for merge until the commits have been signed off.** 
 
 ## Keeping in sync with the Augur Repository
 
-Remeber to sync your fork with the main branch regularly.
-To do this:
-
-Go to github and copy the url of the main Augur repo
-   ```   
-   https://github.com/chaoss/augur.git
-   ```
-   make sure to be in the rootfolder of the project and the branch should be master branch and type
-   ```
-   git remote add upstream https://github.com/chaoss/augur.git
-   ```
-   Now you have your upstream setup in your local machine,whenever you need to make a new branch for making changes make sure your main branch is in sync with the main repository, to do this,make sure to be in the main branch and type
-
-   ```
-   git pull upstream master
-   git push origin master
-   ```
+Remember to sync your fork with the ```main``` branch regularly, by taking the following steps:
+
+- Setup your upstream branch to point to the URL of the main Augur repo ```https://github.com/chaoss/augur.git```.
+
+- Next, in the root folder of the project, on the ```main``` branch, run:
+```
+git remote add upstream https://github.com/chaoss/augur.git
+```
+Whenever you need to make changes, make sure your ```main``` branch is in sync with the main repository, by checking out to the ```main``` branch and running:
+```
+git pull upstream master
+git push origin master
+```
 
 
 ## Community Resources