How to contribute?
You can make this project better by contributing to it. You can report mistakes and errors, create more content, etc. Whatever is your background, there is a way to contribute: via the GitHub website, via command-line or even without dealing with GitHub.
We will address your issues and/or assess your change proposal as promptly as we can, and help you become a member of our community.
How can I report mistakes or errors?
The easiest way to start contributing is to file an issue to tell us about a problem such as a typo, spelling mistake, or a factual error. You can then introduce yourself and meet some of our community members.
How can I get started with contributing?
This repository stores the sources for the website.
How can I contribute in "advanced" mode?
Most of the content is written in GitHub Flavored Markdown with some metadata (a.k.a. front-matter) found in YAML files. Everything is stored on this GitHub repository.
To manage changes, we use GitHub flow based on Pull Requests:
- Create a fork of this repository on GitHub
- Clone your fork of this repository to create a local copy on your computer
- Create a new branch in your local copy for each significant change
- Commit the changes in that branch
- Push that branch to your fork on GitHub
- Submit a pull request from that branch to the master repository
- If you receive feedback, make changes in your local clone and push them to your branch on GitHub: the pull request will update automatically
- Pull requests will be merged by the training team members after at least one other person has reviewed the Pull request and approved it.
What can I do to help the project?
In issues, you will find lists of issues to fix and features to implement. Feel free to work on them!
More specific questions and answers
How can I add a new event?
To add a new event, you will need to manually create an event in the folder
_events. The metadata (front-matter) for events is a bit more complex, it
--- layout: default tags: [talk, training] title: 'Test of DNA extraction and sequencing' starts: 2019-11-10 ends: 2019-11-10 location: city: Freiburg region: Baden Würtemberg country: Germany supporters: - denbi --- ... content ...
Here we specify both a
ends dates to define the dates of the
event. Supplying a
location is used in the user's calendar (if it supports
it), e.g., when the user adds the event to their google calendar, they will see
a map of the location and can easily get directions to it.