Contributing to LogicWay - Hybrid Route Builder

Thank you for considering contributing to LogicWay! Your support helps us improve and grow this open-source project. Below are the guidelines and processes for contributing.

---

How to Contribute

1. Reporting Bugs

If you encounter a bug or an issue:

1. Check the Issues page to see if it’s already reported.
2. If not, create a new issue and include:
   • A clear title and description.
   • Steps to reproduce the issue.
   • Screenshots or logs, if applicable.
3. Tag the issue appropriately (e.g., bug, enhancement, documentation).

2. Suggesting Features

We welcome suggestions for improving LogicWay! To suggest a feature:

1. Open a new issue and label it as feature request.
2. Clearly describe the feature, its purpose, and its potential impact.
3. If possible, include any technical details or mockups.

3. Contributing Code

To contribute code to LogicWay, follow these steps:

Step 1: Fork the Repository

1. Fork the repository to your GitHub account.
2. Clone your forked repository:

   git clone https://github.com/LogicWayTeam/LogicWaySolution.git

3. Navigate to the project directory:

   cd LogicWaySolution

Step 2: Create a Feature Branch

1. Create a new branch for your contribution:

git checkout -b feature-name

Step 3: Make Your Changes

1. Ensure your code follows project standards:

• Python code should comply with PEP 8.
• JavaScript code should follow Airbnb JavaScript Style Guide.

2. Include tests for new features or bug fixes.

Step 4: Commit Your Changes

1. Write clear and concise commit messages:

git commit -m "[added] feature description"

Step 5: Push and Create a Pull Request

1. Push your changes to your forked repository:

git push origin feature-name

2. Go to the original repository and create a Pull Request:

• Provide a detailed description of the changes.
• Reference related issues, if applicable.

---

Guidelines

Code of Conduct

By contributing, you agree to abide by the project's Code of Conduct.

Review Process

1. Pull Requests (PRs) will be reviewed by the maintainers.
2. You may be asked to make revisions before your PR is merged.
3. All contributions must pass automated tests and follow the project's coding standards.

Contributor License Agreement (CLA)

Before your contributions can be merged, you may be required to sign a Contributor License Agreement (CLA). This ensures that contributions are legally compatible with the project.

---

Need Help?

If you have any questions, feel free to open an issue or reach out to the maintainers via the Discussions tab.

Thank you for contributing to LogicWay!