Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (19 loc) · 1.09 KB

CONTRIBUTING.md

File metadata and controls

29 lines (19 loc) · 1.09 KB

Contributing to WikiMediaCache

First off, thank you for considering contributing to Freemap Slovakia!

Development Workflow

  1. Fork the Repository Fork the project to your own GitHub account and clone it locally.

  2. Install Dependencies Run npm install to install all necessary packages.

  3. Make Your Changes

    • We use TypeScript. Make sure your changes are properly typed.
    • Run the server locally using npx tsx src/index.ts to test your changes.
    • Ensure the .env file is properly configured on your local machine (copy from .env.example).

  4. Commit and Push

    • Keep your commit messages clear and descriptive.
    • Push your changes to your fork.

  5. Submit a Pull Request Open a PR against the master (or main) branch of this repository. Briefly describe the problem you're solving or the feature you're adding.

Bug Reports and Feature Requests

If you find a bug or have a feature request, please open an issue on GitHub. Include as much detail as possible (logs, reproduction steps, etc.).

Thank you for helping us improve Freemap Slovakia!