run-llama / rags

Build ChatGPT over your data, all with natural language
MIT License
6.17k stars 629 forks source link

Help new contributers by adding CONTRIBUTING.md. #32

Open justindhillon opened 8 months ago

justindhillon commented 8 months ago

CONTRIBUTING.md tells new contributors how to make pull requests. Here is what it looks like:

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request
alexfilothodoros commented 8 months ago

Nice idea! Maybe it would be useful to add sth like " Run ruff check . before pushing.

justindhillon commented 8 months ago

Nice idea! Maybe it would be useful to add sth like " Run ruff check . before pushing.

Sounds great! The CONTRIBUTING.md file now looks like this:

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Test your changes (ruff check .)
  4. Commit your changes (git commit -am 'Add some feature')
  5. Push to the branch (git push origin my-new-feature)
  6. Create new Pull Request
anoopshrma commented 8 months ago

Great addition @justindhillon !

jerryjliu commented 8 months ago

@justindhillon i think there's a lint error, could you run make format; make lint?

justindhillon commented 8 months ago

@justindhillon i think there's a lint error, could you run make format; make lint?

Thanks @jerryjliu ! I ran the commands and now all tests pass. I also added the formating your code step to the Contributing.md file. It now looks like this:

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Test your changes (ruff check .)
  4. Format your code (make format; make lint)
  5. Commit your changes (git commit -am 'Add some feature')
  6. Push to the branch (git push origin my-new-feature)
  7. Create new Pull Request

Ready to merge.