Skip to content

Latest commit

 

History

History
55 lines (33 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

55 lines (33 loc) · 1.8 KB
Raw

Contributions Guide

Contributions are welcome.

Helping with Translations

See this guide on the wiki

Website

We use middleman for building the website. Check the list of open issues at https://github.com/sarkar-icu/sarkar.icu/issues, and leave a comment on the issue before working on something.

Suggestions

If you have other suggestions, please leave a comment on this issue.

Design

If you'd like to help with poster design or layout, please file an issue

Awareness

If you'd like to help out by raising awareness, link people to the following addresses:

Download the posters from https://github.com/sarkar-icu/sarkar.icu/releases and share them.

Anything else

Reach out to us via the form at https://volunteer.sarkar.icu

How to add a new language

All the YAML files live in locales. New ones can be created by adding a new language in GitLocalize or manually as a file in that directory. If you add it manually:

  • Copy en.yml, rename it to, for example, nag.yml.
  • Change the second line of the YAML file to reflect the language code
  • Update the strings
  • Add the language name and code in the array in source/_languages.erb
  • Add the language in poster-maker/gimmeposters.js. Copy an existing language's code and make sure to update the page.goto URI and the code.screenshot file name to use the correct language code.

How to generate posters

In the root of the repo:

cd poster-maker
npm install
node gimmeposters.js

This will generate the posters and save them in the right place.