Skip to content

CONTRIBUTE.md

Latest commit

 

History

History
73 lines (50 loc) · 2.95 KB

CONTRIBUTE.md

File metadata and controls

73 lines (50 loc) · 2.95 KB

RoboTA Contribution Guide

Fork the github repository

(This part is modified from @Idkmyname's google doc)

What is Fork?

Forking Projects - GitHub

Short explanation will be cloning another person’s public github repository in github.

Steps by steps to fork:

  1. Go to the github repository you want to fork
  2. Find the Fork button, usually on the right-hand corner of the github repository
  3. Click on the Fork button

How to keep a fork sync?

  1. Remote fork
  2. fork syncing

Unit Testing

How to open a pull request

Rules to follow:

  1. Please do testing on your code before opening a pull request.
  2. Please have a detailed explanation on what changes you made to the repository and what it does.
  3. Good titles, not clickbait
  4. More rules https://opensource.creativecommons.org/contributing-code/pr-guidelines/

Steps by steps to create a PR:

  1. Go to the Github repository and find this selection pic1

  2. Click on pull request and click on new pull request pic2

  3. Select the correct repository to compare:

    • The repository you want to open a pull request to Comparing to your own repository.
    • Review the changes you have made.

    pic2_1

  4. Click on Create Pull Request pic3

  5. Follow the rules from there, explain your contribution, then push.

  6. Once the PR is created, you are all set. Your PR will be merged if we review your contribution and if it's good to merge. GitHub will send you email notifications about your PR once any changes are made to your PR.

Git Commit Guidelines

This project has not (yet) enforced a Commit Message Format.

But a more readable messages in your commit could help us to review your code, and approve your contribution quicker.

It's also easier for us to locate problems though the project history later.

Although this project has not (yet) enforced a Commit Message Format, Git Commit Guidelines - Angular.js is a good example and guideline of more readable commits