Contributing to NYU Shuttle

Thank you for your interest in contributing to our project. We welcome your contributions and value your input.

Git Workflow

We follow a Git workflow to manage our codebase. The primary branches are:

main: The main development branch.
feature/*: Feature branches for developing new features.
bugfix/*: Bugfix branches for addressing issues.

Rules of Contributing

When contributing, please adhere to the following rules:

Follow our coding standards
Make sure your contributions align with the project's goals and scope.
Respect other contributors

How to Contribute

To contribute to our project, follow these steps:

Fork the repository to your GitHub account.
Clone the forked repository to your local machine.
git checkout -b feature/your-feature-name
git commit -m "Description of your changes"
git push origin feature/your-feature-name
Open a pull request for your changes

Local Development Environment Setup

Clone the repository to your local machine
Install project dependencies
Set up Google Maps API key
Run the development server