Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix broken links in README and add CONTRIBUTING.md #5

Merged
merged 2 commits into from
Dec 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Contributing to Lit Full Self Signing

We love your input! We want to make contributing to Lit Full Self Signing as easy and transparent as possible, whether it's:

- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer

## We Develop with Github
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html)
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

1. Fork the repo and create your branch from `main`.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes.
5. Make sure your code lints.
6. Issue that pull request!

## Any contributions you make will be under the MIT Software License
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.

## Report bugs using Github's [issue tracker](https://github.com/LIT-Protocol/lit-full-self-signing/issues)
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/LIT-Protocol/lit-full-self-signing/issues/new); it's that easy!

## Write bug reports with detail, background, and sample code

**Great Bug Reports** tend to have:

- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can.
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

## License
By contributing, you agree that your contributions will be licensed under its MIT License.

## References
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md).
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The Lit AI Agent project consists of several packages that work together to prov
? What would you like to do?
```
10. Enter a prompt to get the Lit Agent to send ERC20 tokens to an address:
- For now there is only one Lit Agent tool available: [ERC20 Send](./packages/agent-tool-erc20-send)
- For now there is only one Lit Agent tool available: [ERC20 Send](./packages/fss-tool-erc20-send)
- You can use the `ERC20 Send` tool to send ERC20 tokens to an address by specifying:
- The amount of tokens to send
- The ERC20 contract address
Expand All @@ -60,7 +60,7 @@ The Lit AI Agent project consists of several packages that work together to prov
send <YOUR_AMOUNT> <ERC20_CONTRACT_ADDRESS> to <RECIPIENT_ADDRESS>
```
- For demo purposes, an ERC20 contract address has been deployed on Base Sepolia that allows anyone to mint tokens to any address, it's available at: `0x4070c8325e278ca1056e602e08d16d2D5cd79b27`
- There is a mint Forge script in the [./packages/agent-contracts](./packages/agent-contracts) package that you can use to mint tokens to the address you'd like to test with:
- There is a mint Forge script in the [./packages/fss-contracts](./packages/fss-contracts) package that you can use to mint tokens to the address you'd like to test with:
- Don't forget to initialize the `.env` file using `cp .env.example .env`, the required ENVs for the below commands have default values
- You'll also want to do the following for the Lit Agent wallet:
- **NOTE:** Your Lit Agent's wallet address is saved to the `.agent-signer-storage/pkp` file
Expand All @@ -78,7 +78,7 @@ The Lit AI Agent project consists of several packages that work together to prov
```bash
send 20 0x4070c8325e278ca1056e602e08d16d2D5cd79b27 to 0x600DC16993EA1AbdA674A20d432F93041cDa2ef4
```
the Lit Agent will find a Lit Agent tool registered in the [./packages/agent-tool-registry](./packages/agent-tool-registry) package that satisfies your intent.
the Lit Agent will find a Lit Agent tool registered in the [./packages/fss-tool-registry](./packages/fss-tool-registry) package that satisfies your intent.
11. You should see that the Lit Agent found a Lit Agent tool and is attempting to execute it:
```bash
ℹ️ Executing tool...
Expand Down Expand Up @@ -153,8 +153,7 @@ The Lit AI Agent project consists of several packages that work together to prov
```

- Press `ENTER` or type `Y` and hit `ENTER` to confirm the policy configuration

15. You should see that the policy has been successfully registered on-chain using Lit's [PKP Tool Policy Registry](./packages/agent-contracts/src/PKPToolPolicyRegistry.sol):
15. You should see that the policy has been successfully registered on-chain using Lit's [PKP Tool Policy Registry](./packages/fss-contracts/src/PKPToolPolicyRegistry.sol):
```
ℹ️ Registering policy on chain...
✅ Policy successfully registered! Transaction hash: 0xb8ab7e8e45ffd6cdaffbf44247c95bfb36ab548474786b1b25da29cfa26657d2
Expand Down
Loading