Skip to content

Latest commit

 

History

History
60 lines (50 loc) · 3.73 KB

CONTRIBUTING.md

File metadata and controls

60 lines (50 loc) · 3.73 KB
Raw

I would like to make it better..

Thanks for your contribution!

Determine what to do

There are so many possibilities to start with. For example

  • Studies on API calls like Toolformer
  • Studies on uncertainty in the search results. If the response is unsure or source didn't contain useful info, it shouldn't answer with confident.
  • Studies in open-source model integration and not relies on API. To be better, even using RLHF model
  • Studies on better generation of footnote. In word-level, or instrinsic model generated footnote.
  • Prompt engineering
  • Supports of markdown, code result, point form result, etc.
  • Use it to generate data for training of another LLM model
  • Make a better/robust UI
  • ...

Taking on Tasks

Please create a github issue on a problem that appeals to you. If there are any issues/features you want to address, mention them in your comment along with a brief explanation of how you'll resolve the issue. As soon as a project coordinator assigns you the problem, you can start working on it. (But you can still start first!)

Submitting a Pull Request

(We are not familiar with Github process. This reference LAION-AI/Open-Assistant)

  1. Fork this project repository and clone it to your local machine. (Read more About Forks)
  2. Before working on any changes, try to sync the forked repository to keep it up-to-date with the upstream repository.
  3. On a new branch in your fork (aka a "feature branch" and not master) work on a small focused change that only touches on a few files.
  4. Package up a small bit of work that solves part of the problem into a Pull Request and send it out for review. Here is an example PR for this project to illustrate this flow.
  5. If you're lucky, we can merge your change into master without any problems. If there are changes to files you're working on, resolve them by:
    1. First try to rebase as suggested in these instructions.
    2. If rebasing feels too painful, merge as suggested in these instructions.
  6. Once you've resolved conflicts (if any), finish the review and squash and merge your PR (when squashing try to clean up or update the individual commit messages to be one sensible single one).
  7. Merge in your change and move on to a new issue or the second step of your current issue.

Additionally, if someone is working on an issue that interests you, ask if they need help on it or would like suggestions on how to approach the issue. If so, share wildly. If they seem to have a good handle on it, let them work on their solution until a challenge comes up.

Thank you for your contribution!