Contributing to PrepVerse

PrepVerse is open source and improves through community contributions. All skill levels are welcome.

Ways to help​

Pull request workflow​

# fork the repository on GitHub first, then:
git clone https://github.com/<your-username>/<your-fork>.git
cd <your-fork>/documentation
git checkout -b my-change
npm install
npm start            # live preview at http://localhost:3000
# make your changes, then
npm run lint
npm run build        # must pass: it also checks broken links
git commit -am "Describe your change"
git push origin my-change

Then open a pull request and describe what changed and why.

Lesson style guide​

• One topic per page; start with a one-sentence definition.
• Prefer runnable examples with short comments.
• Use tables for comparisons and complexity summaries.
• Add title and description in the front matter; keep the description under 160 characters.
• Use admonitions (:::tip, :::caution, :::note) sparingly.
• Link related lessons instead of repeating content.

Code of conduct​

Be respectful and constructive. See the Code of Conduct.