Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prompting best practices documentation #4181

Closed
neubig opened this issue Oct 3, 2024 · 4 comments · Fixed by #4183
Closed

Prompting best practices documentation #4181

neubig opened this issue Oct 3, 2024 · 4 comments · Fixed by #4183
Labels
fix-me Attempt to fix this issue with OpenHands

Comments

@neubig
Copy link
Contributor

neubig commented Oct 3, 2024

We should add some documentation of prompting best practices by:

  1. adding a file describing best practices in docs/modules/usage
  2. modifying docs/sidebars.ts

It should provide examples of good prompts and bad prompts to the OpenHands AI software developer, expanding on the text below.


Good prompts are:

  • Concrete: explaining exactly what functionality should be added, what error occurred that needs to be fixed, etc.
  • Explain file locations: if known, explain the locations in the code base that should be fixed
  • Appropriately scoped: they should be the size of a single feature, probably not too much more than 100 lines of code

In general, you can think about the directions that you would give to a junior developer who is not super familiar with the code base, and these will improve the probability of success.

@neubig neubig added the fix-me Attempt to fix this issue with OpenHands label Oct 3, 2024
Copy link
Contributor

github-actions bot commented Oct 3, 2024

OpenHands started fixing the issue! You can monitor the progress here.

Copy link
Contributor

github-actions bot commented Oct 3, 2024

A potential fix has been generated and a draft PR #4182 has been created. Please review the changes.

@neubig neubig added fix-me Attempt to fix this issue with OpenHands and removed fix-me Attempt to fix this issue with OpenHands labels Oct 3, 2024
Copy link
Contributor

github-actions bot commented Oct 3, 2024

OpenHands started fixing the issue! You can monitor the progress here.

Copy link
Contributor

github-actions bot commented Oct 3, 2024

An attempt was made to automatically fix this issue, but it was unsuccessful. A branch named 'openhands-fix-issue-4181' has been created with the attempted changes. You can view the branch here. Manual intervention may be required.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fix-me Attempt to fix this issue with OpenHands
Projects
None yet
1 participant