Project to create a list of places in Austin that hire developers or places that support developers working remotely from Austin. Created by Austin Code Mentorship.
Install by running npm install austin-tech-list
and import it...
import austinTechList from 'austin-tech-list'
console.log(austinTechList) // [{}...]
...or require it.
var austinTechList = require('austin-tech-list')
console.log(austinTechList) // [{}...]
It can also be referenced directly using a service such as unpkg
...
<script src="https://unpkg.com/austin-tech-list"></script>
<script>
console.log(austinTechList) // [{}...]
</script>
If there's a company you'd like added to the list, you can submit a suggestion here.
This project was designed to help new developers get started with their first open source contribution. We welcome pull requests from newbies! If you can think of ways to make the experience easier for developers submit an issue.
Remember, there's nothing to fear about submitting a pull request - everything gets linted, tested, and reviewed before getting added to the master
branch.
There are a few things we test for before we accept changes to the list:
Objects must have name
, homepage
, careers
, address
, and plusCode
keys. No more and no less than those keys.
Entries must be in alphabetical order. This includes things like "The" and "A" since we're just testing with the plain old JavaScript Array.sort()
method.
Addresses must be Remote
or end with Austin, TX \d{5}
where \d{5}
is the five digit ZIP code. If you copy the address from Google Maps, it should be in this format.
Plus codes must be in the format XXXX-XX Austin, Texas
where the X
s are the unique plus code. If you copy the plus code from Google Maps, it should be in this format.
URLs must begin with http://
or https://
. If you copy the URL from your browser, it should be in this format.
You'll need a few things before submitting a pull request.
You'll likely being using a command-line interface to run these commands. This could be Terminal for Mac/Linux, Command Prompt for Windows, or your text editor's build-in terminal if it has one.
Use Github to fork the project. 1
Clone the fork to your computer. 2
Navigate into the project (ex: cd austin-tech-list
).
Run the command npm install
to install project dependencies.
Add an entry to the list in index.js
:
{
// The previous entry
},
{
name: 'Company Name',
homepage: 'https://www.companyname.com/',
careers: 'https://www.companyname.com/jobs/',
address: '123 E 6th St, Austin, TX 78701',
plusCode: '1234+4H Austin, Texas',
},
{
// The next entry
},
Run the command npm run pre-commit
when you're done with your changes. This will change the code to make it conform to our style standards and run tests to make sure everything works as expected. If you get errors here, it probably means a test failed (and your changes need to be tweaked).
Stage and commit your changes. 3
Push your changes from the clone to your fork. 4
Use Github to submit a pull request from your fork to the main project. 5
3 How to stage and commit changes
This is an example and may differ from your own experience. Read about and understand the concepts so that if you run into an error, you'll be better able to discern what the problem is.
Use Github to fork the repo.
git clone https://github.com/[YOUR_USERNAME]/austin-tech-list.git
cd austin-tech-list
npm install
Use your text editor to change index.js
.
npm run pre-commit
git add index.js; git commit -m "Added ExampleCo to list"
git push origin master
Use Github to submit a PR.