Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 2.8 KB

CONTRIBUTING.md

File metadata and controls

66 lines (43 loc) · 2.8 KB
Raw

Contribute your resources

If you are leading one of the hackathon tracks, know of some missing resources, or simply find an error in the listed resources, you can make changes to the repository as follows:

1. Fork the repository

Fork the repository to be able to make your changes, while not affecting the code-base until you are ready to merge. For simple resource changes it is best to refer to the main branch, as it represents the current stable & launched version.

2. Make your changes

You can easily add, remove or adjust resources by editing the content/resources.json file. The file has the following structure:

{
  "resources": [],
  "categories": {
    "title": "My hackathon track",
    "resources": []
  }
}

The most changes you want to make probably need to be made in the respective hackathon-track category. Here you find a title which is displayed in the tab-list, and the resources holding an array where the links to all relevant track resources are located.

A single resource has the following structure, where all attributes are required:

{
  "title": "My resource title",
  "desc": "A short description",
  "url": "https://my-resource-location.eu"
}

You can now go ahead and make changes to this file, using one of the following option.

Using the UI

Navigate to the content directory and click on the resources.json file. Here you can click on the pencil icon to edit the file.

graphic

You can now make your changes right inside the browser. Once you are done commit your changes by using the dedicated section below the displayed file content.

graphic

Make changes locally

Once you have forked the repository, go ahead and clone it locally. You need to install or update node.js Navigate into the cloned directory and run the following command inside the terminal to install the project dependencies.

npm install

First of all, checkout to a new branch to make your changes in. Now you can edit the /content/resources.json file. If you want to preview your changes locally you can simply run the following command:

npm start

Once you have all your changes made don't forget to commit them to the new branch and push it to GitHub. Back in the GitHub web-interface, navigate to your repository fork where you can now create a Pull Request to merge your changes to the main branch of this repository.

graphic