Skip to content

Get started

Start here — your first week

Updated

Page actions

ChatGPT and Claude are third-party services. The link gives them this page's public address and a short instruction. This site records nothing.

The onboarding track for engineers, interns and students joining the SGGS Knowledge Base: what this project is, the one rule that overrides everything, and a five-day path to your first merged change.

Welcome. This project is a study application over Sri Guru Granth Sahib Ji, the scripture and living Guru of the Sikhs: a verbatim corpus of its 1,430 Angs, a search and verification engine, a website (gurbanisoul.com) and an iOS app (Gurbani Soul). You do not need to know Sikh scripture, Gurmukhi or Punjabi to contribute. You do need to work with the text the way this project does: verbatim, cited, never altered.

The one rule

The reverence checklist turns this into concrete habits for everyday engineering work. Read it before you touch anything that displays, searches, copies or stores text.

Five days to a merged change

Your first weekDay one read the rule and the map; day two run everything locally; day three read the invariants and trace one request; day four open a small pull request; day five watch it through CI, staging and the owner's merge.

Day 1 · the rule and the map

Day 2 · run it locally

Day 3 · invariants, trace a request

Day 4 · your first pull request

Day 5 · CI, staging, merged

Your first weekDay one read the rule and the map; day two run everything locally; day three read the invariants and trace one request; day four open a small pull request; day five watch it through CI, staging and the owner's merge.

Day 1 · the rule and the map

Day 2 · run it locally

Day 3 · invariants, trace a request

Day 4 · your first pull request

Day 5 · CI, staging, merged

Your first week
DayDoRead
1Understand what the system is, why it is split into three repositories, and where each kind of change belongs.How the repositories fit together · Architecture overview · Reverence checklist
2Clone, install the pinned database, run the server, the website and this wiki on your machine; run the gates.Run it locally
3Read the rules every change must keep, then follow one search request from the browser to SQLite.Engineering invariants · Search waterfall · Glossary
4Pick a small change, branch from integration, open a pull request the way the project expects.Your first pull request · Branching
5Watch the checks, read what each one proves, see your change on staging, ask for the merge.CI gates · Who to ask

Three sentences to remember

  1. Scripture is data you never write. It arrives from the pinned database and is shown with its Ang: Sri Guru Granth Sahib Ji · Ang N. Explanation is always labelled as explanation.
  2. Everything is proven by CI. You cannot merge; the owner merges after every check is green and the change has been seen on staging. A deploy is verified by the running commit, not a version.
  3. Small, reviewed, reversible. One change per pull request, a conventional-commit title, the PR template filled in, and no tool attribution in commits — only the author’s name.

What you can contribute

Almost everything outside the scripture itself: search quality, the verification engine, the API, the website, the iOS app, documentation, diagrams, tests, tooling and the wiki you are reading. The learning paths group these by role, each a checklist of pages and exercises in order; the engineering handbook is the map of the rules.