Contributors Guide

Prerequisites

Git or any equivalent Version Control System (GitKraten, GitHub Desktop e.t.c)
Code Editor (VsCode, Atom e.t.c)
Little Bash command line knowledge
Basic JavaScript knowledge

Getting Started

If you are new to Git and Github, it is advisable you go through GitHub For Beginners before moving to the next step.
Fork the Repository here
Clone the forked Repository
$ git clone https://github.com/IgalaDigital/Igala-Facts-Extension.git
Enter the cloned directory
cd Igala-Facts-Extension
Open directory in your Code Editor
code .
Load the extension in Developer's Mode as 'UnPacked'
- Open your Chrome Browser
- Click on the three dots at the upper right corner of your tab
- Select More Tools
- Select Extensions
- Click on the Load UnPacked button at the upper left corner
- Locate the directory you cloned the repository to and Click OK
- Now the Extension should be added to the list in Developer's Mode
- Open a New Tab to preview the extension
- Now when you make changes to the cloned repository, this Unpacked Extension would be updated

All Facts are stored in a JSON file which can be found here src/facts.json Quotes are stored in this format

[
    {
        "number": "1",
	"publisher": "Ilemona",
        "fact": "Did you know that Gov Yahaya Bello is now the onu ogwu of igala land?. - Demo Fact"
    }
]

To add a new Fact this Extension; you need to add the Fact to the JSON file

STEP ONE

Every Fact has a designated number, so check the number of the last fact before we proceed
You should have your fact and publisher name already
Facts are in this format

{
        "number": "1",
	"publisher": "Ilemona",
        "fact": "Did you know that Gov Yahaya Bello is now the onu ogwu of igala land?. - Demo Fact"
},

The last fact does not end with a , after the curly brackets }
Any fact before the last facts ends with a ,
To add your fact; first add a , to the last fact after the curly bracket }
Copy and paste this code after the last fact before the ]

{
        "number": "1",
	"publisher": "Ilemona",
        "fact": "Did you know that Gov Yahaya Bello is now the onu ogwu of igala land?. - Demo Fact"
}

Now edit that code snippet to show your own fact;
(Change the number to the last number, add your Publisher name and Fact)

STEP TWO

Push your files

$ git add --all
$ git commit -m "commit description here"
$ git push -u origin master

Open a Pull Request ( What is a pull request? )
Add enough description of what you did, changes you made and if possible screenshots
Wait for Review (Your PR would be reviewed and merged if deemed fit)

Helpful Resources

If you are not a Developer and still want to add a/your Fact to this Extension fill this form and it would be added.

This Guide is Open for Updates, if you feel it is not complete or you have ideas of what should be added, Follow the same format above. This file is stored in README.md Update as you deem fit and send a Pull Request.

Author

IgalaDigital

Licence

MIT

IgalaDigital/Igala-Facts-Extension