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

Central issue for text corrections #26

Closed
BlankCheng opened this issue Oct 25, 2023 · 13 comments
Closed

Central issue for text corrections #26

BlankCheng opened this issue Oct 25, 2023 · 13 comments
Labels
documentation Improvements or additions to documentation Stale

Comments

@BlankCheng
Copy link
Contributor

Hello everyone! 👋

In our continuous effort to maintain and improve the quality of our project’s documentation, we have created this central issue to track any minor typos, grammar issues, or textual inconsistencies that you might come across in our project's text files.

How to Contribute?

  1. Find a Typo or Grammar Issue: While browsing through the project’s documentation or code comments, if you find any typos, grammatical mistakes, or any text that could be improved, take note of it.
  2. Leave a Comment: Reply to this issue with the details of the text that needs correction. Please include:
  • The file name and the line number (if possible).
  • The current text.
  • Your proposed correction or improvement.
  • Any additional context or explanation if necessary.

What Happens Next?

Once you’ve left a comment, our maintainers or contributors will review it, and if necessary, discuss the proposed changes with you. We will batch process the corrections to ensure a streamlined and efficient update to our project.

Why a Central Issue?

We believe that having a central place to track these minor corrections will:

  • Streamline the Process: Make it easier for contributors to report issues and for maintainers to track them.
  • Reduce Clutter: Prevent the repository from getting cluttered with numerous small pull requests for text corrections.
  • Encourage Participation: Provide a low-barrier entry point for new contributors to get involved in the project.

Thank You! We appreciate your help in keeping our project's text clear, accurate, and easy to understand. Your contributions play a vital role in ensuring the quality of our project.

Feel free to customize the issue to better suit your project’s needs. This template aims to provide a clear and welcoming message to encourage contributions, streamline the correction process, and maintain high-quality documentation.

@BlankCheng BlankCheng added the documentation Improvements or additions to documentation label Oct 25, 2023
@BlankCheng BlankCheng pinned this issue Oct 25, 2023
@abhishek213-alb
Copy link

abhishek213-alb commented Oct 25, 2023

File name Readme.md

Current Texts-

  • OpenAgents can analyze data, call plugins, control your browser as ChatGPT Plus, but with OPEN Code for

  • We've released the OpenAgents platform code. Feel free to deploy on your own localhost!

  • Click to see more use case screenshots

Suggestions

  • OpenAgents can analyze data, call plugins, and control your browser as ChatGPT Plus, but with OPEN Code for
  • We've released the OpenAgents platform code. Feel free to deploy it on your localhost!
  • Click here to see more use case screenshots

@abhishek213-alb
Copy link

@BlankCheng Please review this

@BlankCheng
Copy link
Contributor Author

Thanks for pointing out. My only question is why "to" is omitted in the last suggestion. Is "click here to see" more grammarly-correct?

@abhishek213-alb
Copy link

yaa sorry by mistake missed it Can I get it merged ???

@BlankCheng
Copy link
Contributor Author

Yes, after you correct it

@abhishek213-alb
Copy link

@BlankCheng Sir please merge the pr after opening it

@Davidham3
Copy link
Contributor

The file name and the line number: backend/api/tool.py, line 16
The current text: name: name pf a plugin,
Your proposed correction or improvement: name: name of a plugin,

@Davidham3
Copy link
Contributor

The file name and the line number: backend/memory.py, line 103
The current text: # "parent_message_id": the message of the parent message,
Your proposed correction or improvement: name: # "parent_message_id": the id of the parent message,

@BlankCheng
Copy link
Contributor Author

You can solve them in one PR

Copy link

This issue is stale because it has been open 3 days with no activity. Remove stale label or comment or this will be closed in 4 days.

@github-actions github-actions bot added the Stale label Nov 24, 2023
@ztjhz ztjhz removed the Stale label Nov 26, 2023
Copy link

This issue is stale because it has been open 3 days with no activity. Remove stale label or comment or this will be closed in 4 days.

@github-actions github-actions bot added the Stale label Nov 30, 2023
Copy link

github-actions bot commented Dec 4, 2023

This issue was closed because it has been stalled for 4 days with no activity.

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Dec 4, 2023
@Priyanshupareek
Copy link

Updated wording in the warning in README file for better clarity and correctness.

File name & line# : OpenAgents/README.md, line 177

Current text:

p.s.: We have renamed some arguments in code for better readability. If you have pulled the code before 10/26/2023, just a reminder that if you want to you pull the latest code, previous local chat history will be lost because of different key names.

Proposed correction or improvement:

P.S.: We have renamed some arguments in the code for better readability. If you have pulled the code before 10/26/2023, just a reminder that if you pull the latest code, previous local chat history will be lost because of different key names.

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Stale
Projects
None yet
Development

No branches or pull requests

5 participants