Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
93 lines (59 loc) · 3.24 KB

CONTRIBUTING.md

File metadata and controls

93 lines (59 loc) · 3.24 KB

Contributing to OpenRoad

Thank you for your interest in contributing to OpenRoad! We welcome contributions from everyone. By participating in this project, you agree to abide by our Code of Conduct.

How to Get Started

  1. Fork the Repository: Visit the OpenRoad repository and click the "Fork" button.
  2. Clone Your Fork: Clone your fork to work on it locally: 
    git clone https://github.com/KuyeselaOrganization/OpenRoad.git
cd OpenRoad
  3. Explore the Project: Familiarize yourself with the files and structure. You can start by looking at the README.md for an overview of the project.

How You Can Contribute

We value all contributions, whether code, documentation, or ideas. Here’s how you can help:

1. Reporting Bugs

Found a bug? Let us know by creating an issue on GitHub. Include:

  • A clear and descriptive title.
  • Steps to reproduce the bug.
  • Expected and actual behavior.
  • Any relevant logs, screenshots, or additional context.

2. Suggesting Features

Have an idea for improving OpenRoad? Open a feature request issue! Be sure to explain:

  • What the feature is.
  • Why it’s useful or necessary.
  • Any ideas on how it could be implemented.

3. Writing Code

If you’re ready to contribute code:

  • Pick an Issue: Look through the open issues and select one to work on. Issues labeled "Good First Issue" are great for beginners.
  • Discuss Before Starting: Comment on the issue to let others know you’re working on it.
  • Write and Test Your Code: Follow the project’s structure and guidelines.
  • Submit a Pull Request (PR): Push your changes to your fork and open a PR. Include a clear description of your changes and reference the issue it addresses.

4. Improving Documentation

Documentation is key to a great project. You can help by:

  • Fixing typos or clarifying unclear sections.
  • Adding new guides or examples.
  • Updating outdated information.

Guidelines for Contributions

To keep the project manageable and high-quality, please follow these guidelines:

  • Be Respectful: Treat others with respect and kindness.
  • Follow Best Practices: Use clear commit messages, write clean and maintainable code, and include comments where needed.
  • Test Your Work: Ensure your changes work as expected and do not introduce new issues.
  • Stay Aligned with Project Goals: Keep the project’s mission in mind: to build a transparent, secure, and scalable road traffic system.

Areas of Focus

Here are some areas where contributions are particularly helpful:

  • Brainstorming the overall architecture and structure of the system.
  • Designing high-level workflows for traffic management.
  • Proposing technologies or programming languages that align with project goals.
  • Drafting documentation and tutorials.

Need Help?

If you have questions or need guidance:

  • Check the README.md and issues for context.
  • Start a discussion or comment on an issue.
  • Reach out by creating a "help wanted" issue.

Thank You!

Your contributions make OpenRoad better. We appreciate your support in building a world-class, open-source road traffic management system.