Merge pull request #6 from ibm-messaging/contributing

Update CONTRIBUTING.md

Author: moatoum

CONTRIBUTING.md

@@ -2,38 +2,48 @@
 
 Thank you for your interest in contributing to our open-source project, MQ-Ansible. 
 
-To ensure that the codebase is always healthy and does not result in deployment issues when cloned and used, it is important that you pre-check your additions and updates for any potential code conflicts before uploading your changes to the GitHub Repository. 
+To ensure that the codebase is always healthy and does not result in deployment issues when forked and used, it is important that you pre-check your additions and updates for any potential code conflicts before uploading your changes to the GitHub Repository. 
 
 Therefore, the following steps should be followed to submit your contributions: 
 
-1. Clone the project and create a new branch 
+1. Fork the repository
 2. Create and run Ansible Test Playbooks
-3. Commit changes to your branch
-4. Prepare a Pull Request 
-5. Submit the Pull Request 
+3. Commit/Push changes to your fork
+4. Create a Pull Request 
 
 
-### 1. Clone the project and create a new branch 
+### 1. Fork the repository
 
-Once you have cloned the project, create a new branch by running: 
+To fork the repository:
+- Get started by clicking on "Fork" from the top-right corner of the main repository page.
+- Choose a name and description for your fork.
+- Select the option "Copy the main branch only", as in most cases, you will only need the default branch to be copied.
+- Click on "Create fork".
+
+Once you have forked the repository, you can then clone your fork to your computer locally. In order to do that:
+- Click on "Code" (the green button on your forked repository).
+- Copy the forked repository URL under HTTPS.
+- Type the following on your terminal:
 
 ```
-git checkout <your_branch_name> 
+git clone <the_forked_repository_url> 
 ```
 
-You can work locally and commit to your changes to your newly created branch. This will not impact the main branch. If you are looking to add all the files you have modified in a particular directory, you can stage them all with the following command:
+You can set up Git to pull updates from the MQ-Ansible repository into the local clone of your fork when you fork a project in order to propose changes to the MQ-Ansible repository. In order to do that, run the following command:
 
 ```
-git add . 
+git remote add upstream https://github.com/ibm-messaging/mq-ansible
 ```
 
-If you are looking to recursively add all changes including those in subdirectories, you can type: 
+To verify the new upstream repository you have specified for your fork, run the following command:
 
 ```
-git add -A 
+git remote -v
 ```
 
-Alternatively, you can type _git add -all_ for all new files to be staged. 
+You should see the URL for your fork as origin, and the URL for the MQ-Ansible repository as upstream.
+
+Now, you can work locally and commit to your changes to your fork. This will not impact the main branch.
 
 ### 2. Create and run Ansible Test Playbooks
 
@@ -51,44 +61,44 @@ subprocess.run(['ansible-playbook', '--inventory', 'inventory.ini', 'playbook_na
 
 If the playbook runs successfully and no errors are displayed, then proceed to Step #3. 
 
-### 3. Commit changes to your branch 
-
-Once you are ready to submit your changes, ensure that you commit them to your branch with a message. The commit message is an important aspect of your code contribution; it helps the maintainers of MQ-Ansible and other contributors to fully understand the change you have made, why you made it, and how significant it is. 
+### 3. Commit/Push changes to your fork 
 
-You can commit your changes by running: 
+If you are looking to add all the files you have modified in a particular directory, you can stage them all with the following command:
 
 ```
-git commit -m "Brief description of your changes/additions"
+git add . 
 ```
 
-Once you have committed, you can verify what Git will be committing with the git status command.  At this point you can push the changes to the current branch of the main repository: 
+If you are looking to recursively add all changes including those in subdirectories, you can type: 
 
 ```
-git push --set-upstream origin <your_branch_name> 
+git add -A 
 ```
 
-### 4. Prepare a Pull Request 
+Alternatively, you can type _git add -all_ for all new files to be staged. 
 
-Next, specify a new remote upstream repository to sync with the fork. This will be the original main repository that you forked from. You can do this by running the following command: 
+Once you are ready to submit your changes, ensure that you commit them to your fork with a message. The commit message is an important aspect of your code contribution; it helps the maintainers of MQ-Ansible and other contributors to fully understand the change you have made, why you made it, and how significant it is. 
+
+You can commit your changes by running: 
 
 ```
-git remote add upstream https://github.com/ibm-messaging/mq-ansible.git
+git commit -m "Brief description of your changes/additions"
 ```
 
-Now, commits to the main branch will be stored in a local branch called upstream/main. Switch to the local main branch of our repository: 
+To push all your changes to the forked repo:
 
 ```
-git checkout main 
+git push
 ```
 
+### 4. Create a Pull Request
+
 Merge any changes that were made in the original repository’s main branch:
 
 ```
 git merge upstream/main
 ```
 
-### 5. Create a Pull Request 
-
 Before creating a Pull Request, ensure you have read the [IBM Contributor License Agreement](CLA.md). By creating a PR, you certify that your contribution:
 1. is licensed under Apache Licence Version 2.0, The MIT License, or any BSD License.
 2. does not result in IBM MQ proprietary code being statically or dynamically linked to Ansible runtime.