From ebbe70f4a76ccd832eb0ec09242908693cb41bdb Mon Sep 17 00:00:00 2001 From: DJCrossman Date: Thu, 13 Sep 2018 21:05:13 -0600 Subject: [PATCH] docs(README.md): Updated readme to have full steps to add company --- .gitignore | 1 + README.md | 68 ++++++++++++++++++++++++++++++++++++----------------- techmap.iml | 12 ++++++++++ 3 files changed, 60 insertions(+), 21 deletions(-) create mode 100644 techmap.iml diff --git a/.gitignore b/.gitignore index 692ab2f..be4d877 100644 --- a/.gitignore +++ b/.gitignore @@ -16,6 +16,7 @@ *.launch .settings/ *.sublime-workspace +.iml # IDE - VSCode .vscode/* diff --git a/README.md b/README.md index ec42705..d6e7f06 100644 --- a/README.md +++ b/README.md @@ -2,50 +2,76 @@ # HackRegina Tech Map -A map of Regina's tech companies and the technologies they use. +A map of Regina's tech companies and the technologies they use. Check it out here: https://hackregina.github.io/techmap/#/ -#### Adding your company to the list +## Contribute + +We highly encourage learning new technology and process including contributing to open source software. We understand that not everyone will have the skill set but we would love to teach you a new skill. Below we have provided instructions to contribute to this private repository. + +#### Fork the repository + +Forking a repository is a simple two-step process. We've created a repository for you to practice with! -Just add your company to the file `src/assets/data.json` and create a pull request. We will do the rest! +1. On GitHub, navigate to the [HackRegina/techmap](https://github.com/HackRegina/techmap) repository. +2. In the top-right corner of the page, click Fork. + +That's it! Now, you have a fork of the original HackRegina/techmap repository. [Read more on forking here](https://help.github.com/articles/fork-a-repo/). + +#### Adding your company to the list -Listings should be in the following format: +Just add your company to the file [`src/assets/data.json`](src/assets/data.json). You can find out your `lat` and `lng` using [Google Maps](http://maps.google.com/) or [another website](https://www.latlong.net/convert-address-to-lat-long.html). Listings should be in the following format: ``` { - "id": "vivvo", - "name": "Vivvo Application Studios", - "website": "http://www.vivvo.com/", - "address": "300A - 2221 Cornwall Street, Regina, SK., S4P 2L1", - "lat": 50.443612, - "lng": -104.611938, + "id": "hackregina", + "name": "HackRegina", + "website": "https://hackregina.github.io", + "address": "5 Asgar Walk, Regina, SK S4S 6W4", + "lat": 50.415184, + "lng": -104.590244, "technology": [ "AngularJs", "Angular", - "Java", - "Go", "Node.js" ] } ``` -### For companies that are sponsoring HackRegina include the sponsorship tag and level below the "lng": value pair such as: +For companies that are sponsoring HackRegina include the sponsorship tag and level below the `lng`: value pair such as: ``` { - "id": "vivvo", - "name": "Vivvo Application Studios", - "website": "http://www.vivvo.com/", - "address": "300A - 2221 Cornwall Street, Regina, SK., S4P 2L1", - "lat": 50.443612, - "lng": -104.611938, + "id": "hackregina", + "name": "HackRegina", + "website": "https://hackregina.github.io", + "address": "5 Asgar Walk, Regina, SK S4S 6W4", + "lat": 50.415184, + "lng": -104.590244, "sponsorship": "platinum", "technology": [ "AngularJs", "Angular", - "Java", - "Go", "Node.js" ] } ``` + +#### Create a Pull Request + +You can open a pull request to the upstream repository from any branch or commit in your fork. + +1. Navigate to the original repository you created your fork from. +2. To the right of the Branch menu, click New pull request. +3. On the Compare page, click compare across forks. +4. Confirm that the base fork is the repository you'd like to merge changes into. Use the base branch drop-down menu to select the branch of the upstream repository you'd like to merge changes into. +5. Drop-down menus for choosing the head fork and compare branchUse the head fork drop-down menu to select your fork, then use the compare branch drop-down menu to select the branch you made your changes in. +6. Type a title and description for your pull request. +7. If you do not want to allow anyone with push access to the upstream repository to make changes to your PR, unselect Allow edits from maintainers. +8. Click Create pull request. + +[Read more on creating a pull request from a fork here](https://help.github.com/articles/creating-a-pull-request-from-a-fork/). + +#### We will do the rest! + +Great work! Now you have gain the basic skills needed to contribute to open source software. We'll take it from here and merge the changes in. diff --git a/techmap.iml b/techmap.iml new file mode 100644 index 0000000..da8860c --- /dev/null +++ b/techmap.iml @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file