Merge pull request #32 from peshatuhura/doc-fixes

doc-fixes

CONTRIBUTING.md

@@ -30,13 +30,12 @@ Before cloning this repository, make sure you have the latest versions;
 - [NodeJS and NPM](https://nodejs.org/en/download)
 - [MySQL](https://dev.mysql.com/downloads/installer/)
 
-Configure MySQL and make sure it is running on your machine before you proceed with the next steps. create a new **_database_** and a new **_database user_** with a **_password_**. these three values will be used to connect to MySQL and will be needed when setting up your `.env` file.
+Configure MySQL and make sure it is running on your machine before you proceed with the next steps. Create a new **_database_** and a new **_database user_** with a **_password_**. These three values will be used to connect to MySQL and will be needed when setting up your `.env` file.
 
 ### Basic Configurations
+1. You'll need to [create a GitHub OAuth App](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) on your personal GitHub account. Creating a GitHub OAuth App will automatically generate a `Client_ID` and will also enable you to generate a `Client_Secret` for your OAuth App. Store these values safely because they will be needed while generating a `.env` file for the first time.
 
-1. You'll need to [create a GitHub OAuth App](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) on your personal GitHub account. Creating a GitHub OAuth App will automatically generate a `Client_ID` and will also enable you generate a `Client_Secret` for your OAuth App. Store these values safely because they will be needed while generating a `.env` file for the first time.
-
-2. Create your personal [Augur Application](https://projectbadge.chaoss.io/account/settings?section=application) in order to general an `augur_client_secret`. When your new application is created, the `augur_client_secret` will be listed in the last column of **_Your Apps_** table. Store the `augur_client_secret` together with the above GitHub OAuth credentials since it will be needed too while generating a `.env` file for the first time. The `augur_client_secret` is used to connect to the Augur API in order to submit repositories to the Augur Library for further badging.
+2. Create your personal [Augur Application](https://projectbadge.chaoss.io/account/settings?section=application) in order to generate an 'augur_client_secret'. Following the link, you will click on "register" and then fill in a couple of fields as required which will set up an account which you will log into. Click on your username(the one you filled in for the "user ID") at the top left and select "profile" which will take you to account settings. Under the account settings, in the left sidebar, click on "applications" and create a new application by entering an App name and a Redirect URL which will generate the `augur_client_secret` which will be listed in the last column of **_Your Apps_** table. Store the `augur_client_secret` together with the above GitHub OAuth credentials since it will be needed too while generating a `.env` file for the first time. The `augur_client_secret` which is the `AUGUR_CLIENT_SECRET` key is used to connect to the Augur API to submit repositories to the Augur Library for further badging.
 
 After generating those values,
 
@@ -57,16 +56,16 @@ After generating those values,
       npm install # installs packages and dependencies
    ```
 
-2. **Create a Branch**: Create a new branch for your contribution:
+2. **Make sure project is running**:
 
    ```bash
-   git checkout -b your-branch-name
+   npm run dev # this command will trigger a series of configuration questions in order setup your environmental variab>
    ```
 
-3. **Make sure project is running**:
+3. **Create a Branch**: Create a new branch for your contribution:
 
    ```bash
-   npm run dev # this command will trigger a series of configuration questions in order setup your environmental variables
+   git checkout -b your-branch-name
    ```
 
 4. **Make Changes**: Make your desired changes to the codebase. Ensure your code follows our coding standards and guidelines.
@@ -127,6 +126,7 @@ BadgingAPI follows a specific code style and coding standards. Please make sure
 ### Issue Tracking
 
 If you're looking for ways to contribute but don't have specific code changes in mind, you can check the [issue tracker](https://github.com/badging/BadgingAPI/issues) for BadgingAPI on GitHub. You might find issues marked as "help wanted" or "good first issue."
-Ask for help
-If you have any questions or need assistance with your contribution, please contact get in touch with the project maintainers.
+Ask for help;
+If you have any questions or need assistance with your contribution, please contact or get in touch with the project maintainers.
 We appreciate your contributions and look forward to working with you to make BadgingAPI even better!
+