Skip to content

Latest commit

 

History

History
35 lines (28 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

35 lines (28 loc) · 1.69 KB

Contributing Guidelines for Route Master

Welcome to the Route Master project! We appreciate your interest in contributing to the project and making it better. To ensure that all contributions are aligned with the project's goals and standards, please read and follow these guidelines.

Types of Contributions

We welcome the following types of contributions:

Bug fixes

  • Feature enhancements
  • Documentation improvements
  • Testing and QA
  • Code review and feedback

How to Contribute

To contribute to Route Master, please follow these steps:

  1. Fork the repository and create a new branch for your changes.
  2. Make your changes in the new branch.
  3. Test your changes locally to ensure that they work as expected.
  4. Create a pull request from your branch to the main repository.
  5. Wait for the maintainers to review your changes and provide feedback.
  6. Once your changes are approved, they will be merged into the main repository.

Code Standards

To maintain consistency and readability, please follow these code standards:

  • Use Golang standards for naming conventions.
  • Use tabs for indentation.
  • Use descriptive comments for functions and methods.
  • Write clear and concise commit messages.

Reporting Bugs and Issues

If you encounter a bug or issue with Route Master, please report it by creating a new issue in the repository. Please provide a detailed description of the issue, including steps to reproduce it, and any relevant error messages or logs.

Code of Conduct

All contributors are expected to follow the Code of Conduct outlined in the project. The Code of Conduct ensures that all interactions in the community are respectful and professional.

Thank you for your contributions to Route Master!