Skip to content

Latest commit

 

History

History
50 lines (34 loc) · 2.43 KB

contribute.md

File metadata and controls

50 lines (34 loc) · 2.43 KB
Raw

Contribution guide

The primary purpose of this project is to collect useful open source projects and display them by categories and region. Github pages (jekyll) have been used for the website, hence all data are saved in yaml format. Some python scripts are added for postprocessing.

Data format

All data is saved in three files in _data folder.

  • global.yml
    • Contains projects applying to global scale. Used in homepage index.md
  • areas.yml
    • Contains projects focusing on some countries or areas. Used in countries/areas page, area.md
  • china.yml
    • data entries for the projects in china.md

Each project makes up one entry in the file. An entry is defined in meta.yml Add entries in those files, and the website will render and display it automatically.

Where to find projects

  • from your own experience.
  • seen on github and web.
  • from issues and pull requests. etc.

This repository is open an issue as a feedback, with the prescribed title and content. This step is optional.

Added to Open Source COVID-19

Thanks for your work to help the people in need! Your site has been added to the Open-Source-COVID-19 page, which collects open source projects related to COVID-19, including maps, data, news, api, analysis, medical and supply information, etc. Please share to anyone who might need the information in the list, or will possibly contribute to some of those projects. You are also welcome to recommend more projects.

http://open-source-covid-19.weileizeng.com/

Cheers!

Rendering

After adding an entry (and push to the origin), these steps will be done automatically (at every push). They would took one min in total.

  • src/tags.py collect tags in the three data file and save it into tags.yml and tags_projects.yml. These two files are used for the tag page.
  • src/shields.py. generate shields for each project. A shield is an svg picture showing the number of stars.
  • github page rebuild the website

Local test

If you fork it, you can test it by turning on github pages "setting -> github pages -> master banch"

To do a local test. You need to install jekyll first, and then install gems for the project.

  • install ruby environment
  • gem install jekyll bundler
  • bundle install
  • bundle exec jekyll serve

A guide can be found here here to see the installation section.

返回首页