How to Submit Changes

Louisville.io is open source software, meaning anyone can look at how it works and propose changes. If you see something missing, broken, or just want to help out, you can collaborate through our github project.

To Add or Change a Tech Group or Calendar:

  1. Fork the project
  2. Edit the list of groups
  3. If you're adding a new group or updating an existing group's icon, be sure to place the group's icon (in PNG format) in the group-icons folder
  4. Submit a pull request with your changes

Questions?

What's all this GitHub stuff?
We use Git, a version control system, to keep track of the files for this website. GitHub acts as a collaborative platform that hosts everything for us and allows others to propse changes. Don't worry if you haven't used Git or GitHub. GitHub provides some simple ways for you to create a copy of the site (a fork), make changes (commits), and collaborate with others.
What do I need to add to the groups.json file?
The file is formatted as JSON (JavaScript Object Notation), with each group added as a property. The key for the group should be unique and should match the group icon's filename. Your group's property should be another object. Here's an example:

			"game-dev-lou" : {
			  "name": "Game Dev Lou",
			  "frequency": "Meets every other Sunday @ 2pm",
			  "web": "http://gamedevlou.org/",
			  "freenode": "#gamedevlou",
			  "mailing-list": "https://groups.google.com/forum/#!forum/gamedevlou",
			  "calendar": "http://www.meetup.com/GameDevLou/events/ical/",
			  "twitter": "GameDevLouKY"
			},
			
Be sure to point the calendar property to a valid iCalendar address; our build process pulls that down for parsing.
Ok, ok. What's iCalendar?
iCalendar (sometimes iCal) is a file format that can define events, to-do items, journal entries, etc. For events, we can grab the event details from the file, including date, time and place. A lot of calendar programs (Apple iCal, Microsoft Outlook, Google Calendar, etc.) support the format and allow you to import and export it. Sites like Meetup.com offer the ability to download an iCalendar file to import into your favorite calendar app.
Have more questions?
Head over to the Slack channel, and ask away.