Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (35 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

47 lines (35 loc) · 1.43 KB

Contributing

Thank you for your interest in improving the Promised Worlds Wiki!

This is a curated documentation project for the Promised Worlds mod for Kerbal Space Program. Contributions are welcome via pull requests and will be reviewed before merging.

How to contribute

  1. Fork the repository.

  2. Create a branch for your changes.

  3. Run the site locally with:

    pip install mkdocs mkdocs-material
mkdocs serve

  4. Make your edits in the docs/ folder.

  5. Ensure pages are:

    • Linked in mkdocs.yml navigation.
    • Accurate to the current version of Promised Worlds.
    • Include images in the docs/assets/ folder where applicable.

  6. Commit and push your changes.

  7. Open a pull request describing:

    • What you changed.
    • Which Promised Worlds version the changes apply to.
    • Any corrections or new content added.

Style guidelines

  • Keep content clear, concise, and engaging.
  • Use proper markdown formatting.
  • Place images in the docs/assets/ folder and reference them with relative paths.
  • When documenting celestial bodies, include:
    • Physical characteristics
    • Orbital parameters
    • Notable features
    • Gameplay tips where relevant

Reporting issues

If you find a mistake, outdated information, or a missing topic:

  • Open an issue with as much detail as possible.
  • Include the Promised Worlds version you are using.
  • Provide screenshots or references where relevant.