Adding New Esametric Resources
Last updated: Sep 03, 2021
We appreciate your interest in contributing! We hope this guide allows folks from diverse scientific backgrounds interested in single-individual research to add new esametric resources to this site. You do not need to be familiar with git or Github to follow this guide; if you are, please feel free to skip this post, fork our repository and open a pull request with your changes.
The process to add new resources has three steps, create a copy of our public repository, implement your changes, and submit these changes for our approval. Before we start, please sign up for a new GitHub account using this link if you do not have one.
Create a copy of our repository
To create a copy (also called a fork) of our public list of resources, click on this link. In there, GitHub will let you know that You need to fork this repository to propose changes, and so you need to click on the green button labeled Fork this repository, which will take you to a text editor.
Implement your changes
You can add or modify resource items using the text editor that we landed on. This document is written in Markdown. Markdown allows you to format plain text using a specific syntax; if you want to explore its capabilities, check this reference. However, these are the essential elements that you will need to understand:
- List items are proceeded by a
*followed by a blank space.
- Links to other websites have two parts:
(a label and)[an URL]. A label is placed between parenthesis and can be an arbitrary string that will be displayed as-is. The URL to link is placed between square brackets, and the actual text will be invisible to the user. For example
(a link to Google)[https://www.google.com/]
- Italic text must appear between single
*. For instance,
*this text will be displayed in an italic font*
- Bold text must appear between double
*. For example,
**this text will be displayed in bold font**
Tip, you can preview your changes by clicking on the Preview tab at the top of the editor.
Submit your changes for approval
Once your changes are done, go to the bottom of the editor, type a title (for example, Updates for the digital phenotyping section), type a description (for example, I added links to two software tools and one article), and then click on the Propose Changes green button.
On the new page, click on the Create pull request button, then you will have a chance to update your pull request title or description, and when you are ready, click again on the Create pull request button. That's it, we will review your suggested changes as soon as possible, and they will be online shortly after if approved.