60 lines
3.0 KiB
Markdown
60 lines
3.0 KiB
Markdown
# How to Contribute
|
|
|
|
We would love to accept your patches and contributions to this project.
|
|
|
|
## Before you begin
|
|
|
|
### Sign our Contributor License Agreement
|
|
|
|
Contributions to this project must be accompanied by a
|
|
[Contributor License Agreement](https://cla.developers.google.com/about) (CLA).
|
|
You (or your employer) retain the copyright to your contribution; this simply
|
|
gives us permission to use and redistribute your contributions as part of the
|
|
project.
|
|
|
|
If you or your current employer have already signed the Google CLA (even if it
|
|
was for a different project), you probably don't need to do it again.
|
|
|
|
Visit <https://cla.developers.google.com/> to see your current agreements or to
|
|
sign a new one.
|
|
|
|
### Review our Community Guidelines
|
|
|
|
This project follows [Google's Open Source Community
|
|
Guidelines](https://opensource.google/conduct/).
|
|
|
|
## Contribution process
|
|
|
|
### Code Reviews
|
|
|
|
All submissions, including submissions by project members, require review. We
|
|
use [GitHub pull requests](https://docs.github.com/articles/about-pull-requests)
|
|
for this purpose.
|
|
|
|
### gemini-cli alias
|
|
|
|
During development phase, you can use the following to create an alias for
|
|
the command line tool:
|
|
|
|
```bash
|
|
$ npm run build
|
|
$ alias gemini-code="node /path/to/gemini-cli/packages/cli/dist/index.js"
|
|
$ gemini
|
|
██████╗ ███████╗███╗ ███╗██╗███╗ ██╗██╗
|
|
██╔════╝ ██╔════╝████╗ ████║██║████╗ ██║██║
|
|
██║ ███╗█████╗ ██╔████╔██║██║██╔██╗ ██║██║
|
|
██║ ██║██╔══╝ ██║╚██╔╝██║██║██║╚██╗██║██║
|
|
╚██████╔╝███████╗██║ ╚═╝ ██║██║██║ ╚████║██║
|
|
╚═════╝ ╚══════╝╚═╝ ╚═╝╚═╝╚═╝ ╚═══╝╚═╝
|
|
|
|
Tips for getting started:
|
|
1. /help for more information.
|
|
2. Ask coding questions, edit code or run commands.
|
|
3. Be specific for the best results.
|
|
|
|
cwd: /Users/jbd/gemini-cli
|
|
╭────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
|
│ > Enter your message or use tools... │
|
|
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
|
```
|