CONTRIBUTING.md

Contributing Guide

Thank you for your interest in contributing to the Rail Map Painter project! We appreciate your help in improving this open-source project. This guide will walk you through the process of contributing, from setting up your development environment to submitting your pull request.

Table of Contents

• Code of Conduct
• Setting Up Your Development Environment
• Designing and implementing elements
• Submitting an Issue
• Submitting a Pull Request
• Coding Guidelines
• Documentation

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please ensure that your interactions with other contributors are respectful and inclusive.

Setting Up Your Development Environment

Please refer to the Develop Guide in the README for instructions on setting up your development environment.

Designing and implementing elements

We provide tutorials for station, node, and line styles. Check out the one you want to contribute!

• Stations Tutorial
• Nodes Tutorial
• Line Styles Tutorial

Submitting an Issue

Before submitting an issue, please search the existing issues to make sure your issue has not already been reported. If it has not, please create a new issue with a clear, concise description of the problem or feature request.

When reporting a bug, please include the following information:

• A clear and concise description of the issue
• Steps to reproduce the bug
• Expected behavior
• Screenshots or screen recordings, if applicable

Submitting a Pull Request

To submit a pull request, follow these steps:

1. Fork the repository.
2. Create a new branch with a descriptive name, based on the main branch.
3. Make your changes in the new branch, following the Coding Guidelines below.
4. Commit your changes with clear, concise commit messages.
5. Update the documentation, if necessary.
6. Push your branch to your fork.
7. Create a pull request from your fork to the main repository, providing a detailed description of your changes.

Please note that your pull request may be subject to review and discussion before it is merged.

Coding Guidelines

• Write clean, readable, and maintainable code.
• Follow the existing code style and structure.
• Ensure that your code is compatible with the supported platforms and browsers.
• Add comments to explain complex or non-obvious code.
• Test your changes thoroughly before submitting a pull request.

Documentation

If your changes introduce new features or modify existing functionality, please update the relevant documentation. This includes the README, usage documentation, custom components guide, and any other relevant documentation files.

Thank you for contributing to the Rail Map Painter project!