Skip to content

Commit

Permalink
chore: add contributing doc and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
McOso committed Aug 1, 2024
1 parent 13bfc42 commit d9f144c
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 2 deletions.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Contributing to Delegation Framework

Thank you for your interest in contributing to the Delegation Framework! Your contributions help make this project better for everyone. Below are guidelines to help you get started.

## Code of Conduct

This project and everyone participating in it are governed by the [MetaMask Code of Conduct](https://github.com/MetaMask/delegation-framework?tab=coc-ov-file). By participating, you are expected to uphold this code.

## How Can I Contribute?

You can [open an issue](https://github.com/MetaMask/delegation-framework/issues/new/choose) to suggest a feature. Please follow the new feature template. To report a bug, please follow our [security policy](https://github.com/MetaMask/delegation-framework/security/policy).

Before creating a new issue, check the current open and closed issues to see if your concern has already been addressed. Adding a comment to an existing issue can often be more effective.

When suggesting a new feature, provide comprehensive details, particularly about the motivating use cases. Clearly illustrating the feature’s potential impact on the ecosystem can help prioritize its development. High-impact features are given priority, so detailed explanations are highly valued.

### Submitting Pull Requests

All Pull Requests must be paired with an open issue. When creating a Pull Request, you will be presented with a PR template; please be as detailed and thorough as possible to increase the likelihood of your PR being merged.

Create your PR against `main` as the base branch.

Please ensure your pull request adheres to the [style guide](https://github.com/MetaMask/delegation-framework/blob/main/documents/StyleGuide.md) and includes unit tests for new functionality.
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
# Delegation Framework

> [!WARNING]
> We use tags for audited versions of code releases and the `main` branch is the working development branch. All PRs should be based against `main` branch.
### Getting Started

1. **Fork the repository**:
- Click the "Fork" button at the top right of the repository page.

2. **Clone your fork**:
```shell
git clone https://github.com/<your-username>/delegation-framework.git
3. **Create Working Branch**:
```shell
git checkout -b feat/example-branch
# DeleGator Smart Account
A DeleGator Smart Account is a 4337-compatible Smart Account that implements delegation functionality. An end user will operate through a DeleGatorProxy which uses a chosen DeleGator implementation.
Expand Down Expand Up @@ -97,17 +113,20 @@ forge script script/DeployEnvironmentSetUp.s.sol --rpc-url <your_rpc_url> --priv
### Javascript
Read more [here](https://www.notion.so/DeleGator-Developer-Guide-aaa11e5462e8422a85bc8ad70b8d14dc?pvs=4).
Currently in Gated Alpha phase. Sign up to be an early partner [here](https://gator.metamask.io).
### Notes
- We're building against solidity version [0.8.23](https://github.com/ethereum/solidity/releases/tag/v0.8.23) for the time being.
- We're building against Solidity [v0.8.23](https://github.com/ethereum/solidity/releases/tag/v0.8.23) for the time being.
- Format on save using the Forge formatter.
### Style Guide
[Read more on "Style Guide" ->](/documents/StyleGuide.md)
### Core Contributors
[Dan Finlay](https://github.com/danfinlay), [Ryan McPeck](https://github.com/McOso), [Dylan DesRosier](https://github.com/dylandesrosier), [Aditya Sharma](https://github.com/destroyersrt), [Hanzel Anchia Mena](https://github.com/hanzel98), [Idris Bowman](https://github.com/V00D00-child), [Jeff Smale](https://github.com/jeffsmale90), [Kevin Bluer](https://github.com/kevinbluer)
## Relevant Documents
- [EIP-712](https://eips.ethereum.org/EIPS/eip-712)
Expand Down

0 comments on commit d9f144c

Please sign in to comment.