Skip to content

Latest commit

 

History

History
78 lines (48 loc) · 3.15 KB

CONTRIBUTING.md

File metadata and controls

78 lines (48 loc) · 3.15 KB
Raw

Contributing Guide

Thank you for your interest in contributing to this project! We're excited to work with you.

Please review the entirety of this document before opening an issue or submitting a pull request; doing so ensures the process is easy and effective for everyone involved.

Getting Started with UW REACT

This project is just one of many autonomous robotics endeavours undertaken by UW REACT.

What is UW REACT?

The University of Waterloo Robotics Engineering and Autonomous Controls Team (UW REACT) is a student design team composed primarily of undergraduate students at the University of Waterloo. We design, manufacture, program, and train fully autonomous FIRST Robotics Competition (FRC) robots. We field a new robot each year to compete against high school FRC teams without using a human driver.

How can I help?

Depending on your situation, there are two main ways to collaborate:

  • Like normal: Just like any open source team, we maintain an active issue tracker and review pull requests as often as possible, allowing anyone to collaborate on GitHub.
  • Join our team: If you are a student at the University of Waterloo, you can apply to join our core team to gain access to Slack and push permissions to this repository.

Opening Issues

The issue tracker is our preferred method for reporting bugs and suggesting features. We ask that you:

  • DO check if a similar issue has already been reported.
  • DO follow the issue templates for the type of issue you are opening.
  • DO label the issue with the labels specified in the template.
  • DO NOT use the issue tracker for personal support requests. Email [email protected].
  • DO NOT derail or troll issues. Keep discussion on topic.
  • DO NOT post '+1' or '👍' comments. Use GitHub reactions for this.

Submitting Pull Requests

Never embark on a pull request before selecting an issue to solve. If no similar issue exists, please open one first and wait for feedback before proceeding. If you submit a pull request that does not address an open issue, you may spend a lot of time writing changes that we may not merge into the project.

The easiest way to get started once you've selected an issue is:

  1. Fork the project.

  2. Clone your fork:

git clone https://github.com/<your-username>/uwreact_robot.git
  1. Configure your remotes:
git remote add upstream https://github.com/uwreact/uwreact_robot.git
  1. Get the latest changes:
git checkout master
git pull upstream master
  1. Create a new branch off of master:
git checkout -b <branch-name>

  1. Commit your changes.

  2. Locally merge the upstream branch into your branch:

git pull upstream master
  1. Open a pull request

Good First Issues

If you're not sure where to start, we maintain a list of good first issues with a limited scope for each of our projects.