Skip to main content

Wiki Repository Guidelines

Introduction​

This document outlines the guidelines for contributing to the City Skylines Wiki repository. By following these guidelines, you can ensure that your contributions are consistent, well-organized, and easy to understand. The guidelines cover various aspects of contributing to the wiki, including writing style, formatting, and structure.

Prerequisites​

Before you begin contributing to the City Skylines Wiki repository, make sure you have the following:

  • A GitHub account.
  • Basic knowledge of Markdown syntax.
  • Familiarity with the content of the wiki.
  • Git installed on your computer. If you need help with Git installation, refer to the Git installation guide.
  • Node.js installed on your computer.
  • pnpm installed on your computer.
  • A code editor like Visual Studio Code or Atom.

Guidelines​

1. Repository Structure​

The City Skylines Wiki repository follows a specific structure to organize its content effectively. The repository structure is as follows:

  • docs/: Contains all the Markdown files that make up the wiki content.
    • guidelines/: Contains guidelines for contributing to the wiki.
    • standards/: Contains standards for writing commit messages and other documentation.
    • templates/: Contains templates for various types of pull requests.
    • guides/: Contains guides on various topics related to the wiki content.

2. Writing Style​

When contributing to the wiki, follow these writing style guidelines:

  • Use clear and concise language.
  • Avoid jargon and technical terms unless necessary.
  • Use headings and subheadings to organize content.
  • Use bullet points and numbered lists for step-by-step instructions.
  • Use code blocks for code snippets and terminal commands.
  • Use inline code formatting for file paths, commands, and code elements.
  • Use descriptive file and folder names.

3. Formatting​

Follow these formatting guidelines when writing content for the wiki:

  • Use Markdown syntax for formatting text.
  • Use headings (#, ##, ###, etc.) to structure the content.
  • Use bold (**text**) and italic (*text*) formatting for emphasis.
  • Use blockquotes (> text) for quotes and notes.
  • Use code blocks (```) for code snippets and terminal commands.
  • Use tables for tabular data.
  • Use images and links to enhance the content.

4. Contribution Process​

To contribute to the City Skylines Wiki repository, follow these steps:

  1. Clone repository to your local machine.
  2. Create a new branch for your changes.
  3. Make your changes to the Markdown files.
  4. Test your changes locally using the wiki preview tool. Additionally, you can run pnpm run build && pnpm run serve to build the wiki locally and view it in your browser.
  5. Commit your changes following the commit message standards.
  6. Push your changes to your forked repository.
  7. Create a pull request to merge your changes into the main repository. Use the appropriate template for your pull request.

5. Review Process​

All contributions to the City Skylines Wiki repository are reviewed by the maintainers. During the review process, the maintainers will check the following:

  • Adherence to the guidelines outlined in this document.
  • Accuracy and completeness of the content.
  • Consistency with existing content.
  • Proper formatting and structure.
  • Compliance with the commit message standards.

6. Collaboration​

Collaboration is encouraged in the City Skylines Wiki repository. You can collaborate with other contributors by:

  • Reviewing and providing feedback on pull requests.
  • Suggesting improvements to existing content.
  • Working together on new guides, standards, or templates.
  • Participating in discussions on GitHub issues.