How to Contribute
playZE is open source and community-maintained. All content is written in Markdown and lives in this GitHub repository. Contributing is done via pull request — no special access required.
Licensing
Section titled “Licensing”Everything in this repository, code and content alike, is licensed under the GPL-3.0. Contributions are accepted under the same license (inbound = outbound). No CLA is required.
What you can contribute
Section titled “What you can contribute”- New map guides: document a map using the map template.
- Updates to existing guides: fix outdated strats, update item info after a map rework, add a missing stage.
- Translation: translate a page to another language (see the Lunaria dashboard for what needs translating).
- Corrections: fix factual errors, broken links, or spelling.
- Content pages: add sections to skills pages, improve the glossary, expand reference material.
Quickstart: editing an existing page
Section titled “Quickstart: editing an existing page”Every page has an “Edit this page” link in the footer (on GitHub). Click it to open the file in GitHub’s web editor:
- Edit the Markdown.
- Click “Commit changes” at the top right.
- Select “Create a new branch” and submit a pull request.
Adding a new map guide
Section titled “Adding a new map guide”- Fork the repository on GitHub.
- Copy
src/content/docs/maps/_map-template.md. - Rename the copy to the map’s filename (e.g.
ze_best_korea.md). Preserve underscores exactly as they appear in the map name. - Fill in every section of the template. Remove the template comments.
- Commit to your fork and open a pull request against the
mainbranch. - A maintainer will review and merge.
See the map template and ze_example for reference.
Adding a _p variant
Section titled “Adding a _p variant”CS2 _p port maps get their own separate file. Create ze_mapname_p.md as a new independent guide — don’t modify the base map’s page. Mention in the overview that this guide covers the CS2 _p port.
For all ports or minor map versions
Section titled “For all ports or minor map versions”If a minor update version of a map is similar enough to the major version prior, or if a map was ported and there were little to no changes, it is acceptable to simple state that in the minor version/port guide doc and link to the existing doc for the original map.
Example: ze_best_korea_p is basically the same as ze_best_korea, so just back-linking from ze_best_korea_p to ze_best_korea would suffice.
Local development
Section titled “Local development”To run the site locally:
git clone https://github.com/playZE-gg/playZE.gg.gitcd playZE.ggnpm installnpm run devThe site runs at http://localhost:4321. Edit Markdown files and the browser updates live.
Prerequisites: Node.js 18+.
Pull request checklist
Section titled “Pull request checklist”Before submitting a PR:
- Spell-checked the content
- Verified that any internal links work
- Filled in all template sections (for map guides — no empty template sections left)
- Set
lastTestedandmapVersionfrontmatter (for map guides) - Ran
npm run buildlocally — no errors
Getting help
Section titled “Getting help”Join the Discord to ask questions, propose new map guides, or discuss the project.