Help new contributers by adding CONTRIBUTING.md. by justindhillon · Pull Request #32 · run-llama/rags · GitHub
Skip to content

Help new contributers by adding CONTRIBUTING.md.#32

Open
justindhillon wants to merge 7 commits intorun-llama:mainfrom
justindhillon:main
Open

Help new contributers by adding CONTRIBUTING.md.#32
justindhillon wants to merge 7 commits intorun-llama:mainfrom
justindhillon:main

Conversation

@justindhillon
Copy link
Copy Markdown

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
Copy link
Copy Markdown
Contributor

@justindhillon
Copy link
Copy Markdown
Author

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
Copy link
Copy Markdown
Contributor

Great addition @justindhillon !

Copy link
Copy Markdown
Contributor

@jerryjliu jerryjliu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

amazing thanks!

@jerryjliu
Copy link
Copy Markdown
Contributor

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

@justindhillon
Copy link
Copy Markdown
Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants