Skip to content
This repository was archived by the owner on Aug 28, 2024. It is now read-only.

Commit ebbe70f

Browse files
committed
docs(README.md): Updated readme to have full steps to add company
1 parent 2c6cfad commit ebbe70f

File tree

3 files changed

+60
-21
lines changed

3 files changed

+60
-21
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
*.launch
1717
.settings/
1818
*.sublime-workspace
19+
.iml
1920

2021
# IDE - VSCode
2122
.vscode/*

README.md

Lines changed: 47 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,50 +2,76 @@
22

33
# HackRegina Tech Map
44

5-
A map of Regina's tech companies and the technologies they use.
5+
A map of Regina's tech companies and the technologies they use.
66

77
Check it out here: https://hackregina.github.io/techmap/#/
88

9-
#### Adding your company to the list
9+
## Contribute
10+
11+
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.
12+
13+
#### Fork the repository
14+
15+
Forking a repository is a simple two-step process. We've created a repository for you to practice with!
1016

11-
Just add your company to the file `src/assets/data.json` and create a pull request. We will do the rest!
17+
1. On GitHub, navigate to the [HackRegina/techmap](https://github.com/HackRegina/techmap) repository.
18+
2. In the top-right corner of the page, click Fork.
19+
20+
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/).
21+
22+
#### Adding your company to the list
1223

13-
Listings should be in the following format:
24+
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:
1425

1526
```
1627
{
17-
"id": "vivvo",
18-
"name": "Vivvo Application Studios",
19-
"website": "http://www.vivvo.com/",
20-
"address": "300A - 2221 Cornwall Street, Regina, SK., S4P 2L1",
21-
"lat": 50.443612,
22-
"lng": -104.611938,
28+
"id": "hackregina",
29+
"name": "HackRegina",
30+
"website": "https://hackregina.github.io",
31+
"address": "5 Asgar Walk, Regina, SK S4S 6W4",
32+
"lat": 50.415184,
33+
"lng": -104.590244,
2334
"technology": [
2435
"AngularJs",
2536
"Angular",
26-
"Java",
27-
"Go",
2837
"Node.js"
2938
]
3039
}
3140
```
3241

33-
### For companies that are sponsoring HackRegina include the sponsorship tag and level below the "lng": value pair such as:
42+
For companies that are sponsoring HackRegina include the sponsorship tag and level below the `lng`: value pair such as:
3443
```
3544
{
36-
"id": "vivvo",
37-
"name": "Vivvo Application Studios",
38-
"website": "http://www.vivvo.com/",
39-
"address": "300A - 2221 Cornwall Street, Regina, SK., S4P 2L1",
40-
"lat": 50.443612,
41-
"lng": -104.611938,
45+
"id": "hackregina",
46+
"name": "HackRegina",
47+
"website": "https://hackregina.github.io",
48+
"address": "5 Asgar Walk, Regina, SK S4S 6W4",
49+
"lat": 50.415184,
50+
"lng": -104.590244,
4251
"sponsorship": "platinum",
4352
"technology": [
4453
"AngularJs",
4554
"Angular",
46-
"Java",
47-
"Go",
4855
"Node.js"
4956
]
5057
}
5158
```
59+
60+
#### Create a Pull Request
61+
62+
You can open a pull request to the upstream repository from any branch or commit in your fork.
63+
64+
1. Navigate to the original repository you created your fork from.
65+
2. To the right of the Branch menu, click New pull request.
66+
3. On the Compare page, click compare across forks.
67+
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.
68+
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.
69+
6. Type a title and description for your pull request.
70+
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.
71+
8. Click Create pull request.
72+
73+
[Read more on creating a pull request from a fork here](https://help.github.com/articles/creating-a-pull-request-from-a-fork/).
74+
75+
#### We will do the rest!
76+
77+
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.

techmap.iml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<module type="WEB_MODULE" version="4">
3+
<component name="NewModuleRootManager" inherit-compiler-output="true">
4+
<exclude-output />
5+
<content url="file://$MODULE_DIR$">
6+
<excludeFolder url="file://$MODULE_DIR$/dist" />
7+
<excludeFolder url="file://$MODULE_DIR$/tmp" />
8+
</content>
9+
<orderEntry type="inheritedJdk" />
10+
<orderEntry type="sourceFolder" forTests="false" />
11+
</component>
12+
</module>

0 commit comments

Comments
 (0)