ubiquity / pay.ubq.fi

Generate and claim spender permits (EIP-2612)
https://pay.ubq.fi
8 stars 28 forks source link

Default `.env` in README.md #244

Closed Keyrxng closed 2 weeks ago

Keyrxng commented 3 weeks ago

Rather than have a generic fill-in-your-own approach with the readme it should have the default expected values to remove friction for new devs as there still seems to be some obscurity seeing the comment below.

The thing is just like many other developers I don’t understand web3 and the language around it. The Docs are written assuming you know web3 (understandably) and coming from a non web3 background it’s a bit difficult getting started

This is one of the less complex codebases imo so comments like this are invaluable from non-Web3 natives.


The default config should be the same as the config used in tests, same wallet addresses, correct associated PK, correct RPC endpoint etc.

The reason why is we have yarn test:anvil & yarn test:fund which handles the local setup e2e, they should only need to run these commands and be immediately able to claim the ERC20 permit generated with yarn start.


Should a new small section be added to the readme, a layman's terms approach on exactly to do, ELI5-type step-by-step? Unsure if it's overkill considering the amount of info in it already.

time: < 1 hour
0x4007 commented 2 weeks ago

time: < 1 hour

FYI we can consider making issue templates that will allow you to add a time label.

Example https://github.com/ubiquity/ubiquibar/tree/development/.github/ISSUE_TEMPLATE

Keyrxng commented 2 weeks ago

time: < 1 hour

FYI we can consider making issue templates that will allow you to add a time label.

Example https://github.com/ubiquity/ubiquibar/tree/development/.github/ISSUE_TEMPLATE

Those tees were so badass 😂

I like this idea but like you said on TG, I'm not fussed by it for as long as it's not an inconvenience to the team.

I was going to suggest it may be a good idea for contributors in general to have a template for suggesting a time estimate, although maybe not given their potential understanding of codebases

ubiquibot[bot] commented 2 weeks ago
+ Evaluating results. Please wait...
ubiquibot[bot] commented 2 weeks ago

[ 4.7 WXDAI ]

@0x4007
Contributions Overview
ViewContributionCountReward
IssueComment12.6
ReviewComment12.1
Conversation Incentives
CommentFormattingRelevanceReward
> time: < 1 hour FYI we can consider making issue templ...
2.60.492.6
You can use any ChatGPT 4o processed version in place of your su...
2.10.112.1

[ 127.3 WXDAI ]

@Keyrxng
Contributions Overview
ViewContributionCountReward
IssueSpecification136.2
IssueTask150
IssueComment113.2
IssueComment10
ReviewComment218.6
ReviewComment29.3
Conversation Incentives
CommentFormattingRelevanceReward
Rather than have a generic fill-in-your-own approach with the re...
36.2
h5:
  count: 1
  score: "1"
  words: 4
code:
  count: 3
  score: "3"
  words: 8
136.2
> > time: < 1 hour > > FYI we can consider mak...
13.20.44513.2
> > time: < 1 hour > > FYI we can consider mak...
-0.445-
> The level of detail is good on the README, but consider usi...
14.60.6714.6
https://github.com/ubiquity/pay.ubq.fi/actions/runs/9472156534/j...
40.354
> The level of detail is good on the README, but consider usi...
7.30.677.3
https://github.com/ubiquity/pay.ubq.fi/actions/runs/9472156534/j...
20.352