Skip to content

Latest commit

 

History

History
75 lines (45 loc) · 3 KB

CONTRIBUTING.md

File metadata and controls

75 lines (45 loc) · 3 KB
Raw

Contribution Guidelines

Welcome to the University of Auckland's Formula SAE (FSAE) Autonomous Vehicle project repository! We are excited that you are interested in contributing to this project. In order to maintain a high level of quality and organization, we have set up these guidelines to help you get started.

Table of Contents

  1. Introduction
  2. Getting Started
  3. Submitting Changes
  4. Coding Guidelines
  5. Reporting Issues
  6. Contact

Introduction

This project aims to develop an autonomous FSAE car for the University of Auckland FSAE team. We are looking for team members, collaborators, and contributors with expertise in various domains, such as control systems, computer vision, machine learning, and more.

NOTE: To contribute to this project, you must be a member of the University of Auckland FSAE team or obtain special permission. If you are not a member and want to contribute, please contact Chris Graham to discuss further.

Getting Started

  1. Fork the repository by clicking the "Fork" button on the top-right corner of the page.

  2. Clone your fork to your local machine:

    git clone https://github.com/YOUR_USERNAME/fsae-autonomous.git

  3. Set up the development environment by following the instructions in the README.md file.

Submitting Changes

  1. Create a new branch with a meaningful name for the changes you want to make:

    git checkout -b my-feature-branch

  2. Commit your changes with a clear and descriptive commit message.

  3. Push your branch to your fork on GitHub:

    git push origin my-feature-branch

  4. Open a pull request (PR) from your fork to the main repository. Please make sure to provide a detailed description of the changes you made and reference any related issues.

  5. Wait for the maintainers to review your PR. They may request changes or provide feedback. Make sure to address any comments or concerns promptly.

Coding Guidelines

  1. Follow the established coding style and conventions used in the project. This ensures consistency and makes the code easier to read and maintain.

  2. Write clean and maintainable code. Make sure to add comments and documentation where necessary.

  3. Keep your code modular and well-organized.

  4. Write unit tests for your code and ensure existing tests continue to pass.

Reporting Issues

If you encounter any bugs or issues, please file a report on the GitHub issue tracker. Be sure to include the following information:

  1. A clear and concise description of the issue.
  2. Steps to reproduce the issue.
  3. Any relevant logs or error messages.
  4. Your system configuration and environment.

Contact

If you have any questions or concerns, please contact Chris Graham.

Thank you for your interest in contributing to the University of Auckland's FSAE Autonomous Vehicle project. Together, we can make this project a success!