Skip to content

Latest commit

 

History

History
79 lines (58 loc) · 3.4 KB

PR-Guide.md

File metadata and controls

79 lines (58 loc) · 3.4 KB
Raw

WHY PULL REQUESTS?

Explanation here.

How do I do a pull request? Go here.

I WANT TO ADD A

EDUCATIONAL RESOURCE

Modify the README.md and follow the format

* ** Short Title**: "TITLE", PERSON, COURSE, INSTITUTION, YEAR. [[Content](link)]

For example:

  • LLMs Control Robots: "Controlling Robots Via Large Language Models", Sanjiban Choudhury, CS 4756/5756, Cornell, 2023 [Slides]

RESEARCH PAPER

Modify the README.md and follow the format

* ** Short Title**: "TITLE", CONFERENCE, YEAR. [[Paper/PDF](link)] [[Code](link)] [[Website](link)]

For example:

  • ZSP: "Language Models as Zero-Shot Planners: Extracting Actionable Knowledge for Embodied Agents", arXiv, 2022. [Paper] [Pytorch Code] [Website]

PROJECT DEMO

Modify the README.md and follow the format

* ** Short Title**: "TITLE", PERSON (OPTIONAL), INSTITUTION (OPTIONAL), YEAR [[Video](link)]

For example:

  • SPOT GPT: "Boston Dynamics Integration of ChatGPT into SPOT Robot", Boston Dynamics, 2023, [Video]

THOUGHTFUL TWITTER THREAD

Modify the README.md and follow the format

* ** Short Title**: @USERNAME, YEAR. [[Thread](link)]

For example:

  • Bitter Lesson 2.0: @hausman_k, 2023 [Thread]

CLEAN UP

Modify the designated file and follow the format

ERROR IDENTIFIED: [FILE/HEADING/SHORT TITLE], BRIEF DESCRIPTION OF ERROR
ERROR FIX: [ERROR LOCATION], BRIEF DESCRIPTION OF HOW ERROR WAS FIXED

For example:

ERROR IDENTIFIED: [README.MD/PROJECT DEMO/SPOT GPT], The link is dead

ERROR FIX: [README.MD/PROJECT DEMO/SPOT GPT], The link was replaced with a working link

ADMINISTRATIVE CHANGES

This is more informal since it is intended to be a catch-all, but if you have an idea for how to improve Everything-LLMs-And-Robotics then follow this format, which if approved will be implemented ASAP. Try to keep suggestions as small and modular. If you have a very big idea, send multiple pull requests to allow for your vision to be more clearly articulated:

WHAT IS YOUR IDEA: Brief description
"SO WHAT?" (WHY SHOULD WE DO THIS): Brief Description
HOW ARE WE GOING TO DO THIS?: Brief Description

For example:

WHAT IS YOUR IDEA: I think we should add a new section for twitter accounts that people should follow in LLMs + Robotics

"SO WHAT?" (WHY SHOULD WE DO THIS): This would help to further strengthen the community.

HOW ARE WE GOING TO DO THIS?: We can create a new section in README.md and a new PR format in PR GUIDE.md