root/llama.cpp
1
0
Fork 0
mirror of https://github.com/ggerganov/llama.cpp.git synced 2024-11-11 21:39:52 +00:00
Code Issues Actions 12 Packages Projects Releases Wiki Activity
99052cd227
llama.cpp/CONTRIBUTING.md
Nicolás Pérez 57bf62ce7c
docs: Added initial PR template with directions for doc only changes and squash merges [no ci] (#7700) 
This commit adds pull_request_template.md and CONTRIBUTING.md . It focuses on explaining to contributors the need to rate PR complexity level, when to add [no ci] and how to format PR title and descriptions.

Co-authored-by: Brian <mofosyne@gmail.com>
Co-authored-by: compilade <git@compilade.net>
2024-06-10 01:24:29 +10:00

1.3 KiB
Raw Blame History

Contributing Guidelines

Checklist

  • Make sure your PR follows the coding guidelines
  • Test your changes using the commands in the tests folder. For instance, running the ./tests/test-backend-ops command tests different backend implementations of the GGML library
  • Execute the full CI locally on your machine before publishing

PR formatting

  • Please rate the complexity of your PR (i.e. Review Complexity : Low, Review Complexity : Medium, Review Complexity : High). This makes it easier for maintainers to triage the PRs.
    • The PR template has a series of review complexity checkboxes [ ] that you can mark as [X] for your conveience. Refer to About task lists for more information.
  • If the pull request only contains documentation changes (e.g., updating READMEs, adding new wiki pages), please add [no ci] to the commit title. This will skip unnecessary CI checks and help reduce build times.
  • When squashing multiple commits on merge, use the following format for your commit title: <module> : <commit title> (#<issue_number>). For example: utils : Fix typo in utils.py (#1234)