Quizzes are a fun and engaging way to onboard new developers to your codebase and keep them up-to-date as your application evolves.
Any repo collaborator can take quizzes and contribute new questions. Each repo has one quiz and each quiz has multiple questions. You can create groups to keep related questions together.
This folder contains the following files:
A JSON representation of your quiz, generated by the GitQuiz CLI.
The public key provided by GitQuiz for your repo, used by the CLI to encrypt answers.
- readme.md (optional)
A markdown file whose contents will appears on your repo's page on gitquiz.com if it exists. Good for introducing developers to your application.
First, signup to create an account. GitQuiz is completely free for unlimited public repos and up to one private repo.
Activate a repo by clicking the "Add" button:
You should see a public key on your repo's page at
In that repo, install the CLI.
Initialize GitQuiz with the public key found on your repo's page.
Use the interactive prompt to add your first question, commit and push.
Refresh your repo's page at
gitquiz.com/gh/[repo_owner]/[repo_name] and you should see a "Get Started" button. Click it to start the quiz.
Using the CLI (recommended):
Add a question:
Edit a question or answer:
Remove a question:
encrypt commands to generate a question ID and encrypted answer. Modify the JSON to add a new question object to the questions array, containing an ID, question and encrypted answer.
Edit a question by simply replacing the question text in the JSON. To modify an answer, use the
encrypt command and replace the current answer value.
To remove a question simply remove the question object from the questions array.
Create a new group:
Move question objects into the group's
Use these commands to validate your JSON and preview the quiz structure:
By default you will receive an email notification whenever a new question is added to a repo you collaborate on, or an existing answer is changed. This helps you stay up-to-date on any changes.
You can disable these notifications in your account settings.
Your badge will be accessible at the following URL:
gitquiz.com/gh/[repo_owner]/[repo_name]/badge. You can find pre-generated markdown on the repo settings page.
Email support at email@example.com
How many questions can a quiz have?
What happens when I delete a question?
What if I don't want to use NPM?
Which branch is used for the quiz?
masterbranch will be used to generate the quiz. In the future we'll add support for other branches.
Will I lose my response history if I deactivate a repo?
I have a feature request or want to report a bug.
I have a question that wasn't answered here.