-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Initial first pass at contributing guide
- Loading branch information
Showing
1 changed file
with
43 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,43 @@ | ||
# context | ||
# context | ||
|
||
By default, EVM based transactions are inscrutable and are lacking details about the context and intent of the transaction. Once Upon proposes standardizing a context layer on top of the protocol level data to help network operators, developers, and end users better understand what is happening onchain. | ||
|
||
The npm package can be found [here](https://www.npmjs.com/package/@once-upon/evm-context). | ||
|
||
## Quick start | ||
|
||
### Generating a new contextualization | ||
|
||
Run this command `npm run create --name [name of protocol]` | ||
|
||
This will generate a new file called `protocol/[name of protocol].ts` and a test file called `protocol/[name of protocol].spec.ts`. | ||
|
||
### Writing tests | ||
|
||
You should write unit tests for your PR using a real transaction. | ||
|
||
You can do this by running `npm run grab:transaction --hash [txHash] --prefix [nickname for the type of tx]`. | ||
|
||
### Finishing your new contextualization | ||
|
||
Once that's ready, please open a PR on this repo and request review from `pcowgill` and `jordanmessina` | ||
|
||
# Overview | ||
|
||
## Definitions | ||
|
||
### Template Variables | ||
|
||
### Summary | ||
|
||
#### Description | ||
|
||
#### Title | ||
|
||
#### Context Action | ||
|
||
## Types of contextualizations | ||
|
||
##### Protocol | ||
|
||
##### Heuristic |