Contributor's Workflow

0. GitHub account and Git basics

   1. If you don't have one yet, create a GitHub account. It's free and no hidden costs burried.

   2. In case you have never used GIT before, a brief explanation of the very basics can be found e.g. here. Or just use your favorite search engine, there are many and more tutorials for GIT out there.

1. If this is the first time you are contributing to the website: Fork the repository.

   If you already forked the repository before, you may want to sync your fork now (be sure to sync both your master and source branches).

2. Clone your fork.
   You can copy the link from your fork's GitHub page. The URL looks like [email protected]:[YOUR_USERNAME]/jlesc.github.io.git.

3. Checkout the source branch.
   ❗ Note: You never directly modify the master branch.
   It is created automatically from the source branch. If you do not see folders like e.g. _methods (with a preceding underline) you are probably in the master branch.

4. Create a feature branch feature/new-bibtex-refs or feature/typo-fix

5. Add new content, fix existing or add missing publications.

   1. Read Creating Pages or News.
      If you are not familiar with markdown, just look at existing entries: It is easy.

   2. Read Adding Publications.
      Adding a new or missing publication to the list is easy as adding a BibTeX entry to the BibTeX file.

6. Read Testing Locally to see how you can view the website locally on your computer.

7. Add and commit your changes, then push them to your forked repository on GitHub.

8. Create a pull request (PR) against the source branch

9. Wait for one of the admins to merge your PR and see your content online