From 9050293e21d5874b1d288141847a37dafa6c1a2d Mon Sep 17 00:00:00 2001 From: Alain Nicolas Date: Fri, 13 Oct 2023 18:28:36 +0200 Subject: [PATCH] chore: Publish the Ways of Working --- CONTRIBUTING.md | 77 ++++++++++++++++++++++++++++++++++++++ README.md | 25 +++++++++---- doc/verax-logo-circle.png | Bin 0 -> 7681 bytes 3 files changed, 94 insertions(+), 8 deletions(-) create mode 100644 CONTRIBUTING.md create mode 100644 doc/verax-logo-circle.png diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..5a327113 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,77 @@ +# Verax Attestation Registry - Contribution Guide + +Verax Attestation Registry is a community-led initiative, with developers from various companies and different +backgrounds. While we are more than happy to get help from multiple sources, we need to rely on strong Ways of Working. + +## Project Management + +We use Notion for meeting minutes and other WIP documents such as the functional backlog. +Task tracking is done through [GitHub issues](https://github.com/Consensys/linea-attestation-registry/issues) and +[GitHub Project](https://github.com/orgs/Consensys/projects/17/views/2). + +_Contact us to get access_ + +## Issue Lifecycle + +The lifecycle of an issue is as follows: + +1. Draft +2. Next Milestone +3. Ready for development +4. In progress +5. Blocked +6. Peer-review +7. QA +8. Done +9. Released +10. Won’t do + +## Meetings + +- Core contributors meet on Monday, Wednesday and Friday for a **sync call**. +- **Technical Workshops** are held every Monday. +- **Functional Reviews** are held every Thursday. +- **Office Hours** are held every other Thursday. + +## Branching Model + +Our project follows the GitFlow branching model. +Here's a brief overview of the branches we use: + +- `main`: This branch contains the latest release of the project. +- `release/VERSION_NUMBER`: This branch contains code that has been validated by the QA process and is ready for + release. +- `dev`: This branch contains the latest features that have been developed but not yet released. +- `feature/slug-name`: Each feature ticket has its own branch for development. +- `bugfix/slug-name`: Each bug ticket has its own branch for development. +- `chore/name`: Each task ticket has its own branch for development. + +When creating a pull request, please follow the same naming pattern as branch naming: `feat: Title of the ticket`. +All commits of a PR are squashed and branches are deleted after merging. +Merging requires at least one peer-review from the code owners, but two are encouraged. +You cannot validate your own PR. +Rebasing is strongly encouraged. +Personal forks are allowed, but CI tests must pass before merging. + +## Development + +Our code repository is hosted on GitHub. +We use the Foundry framework for Solidity development. +The project includes linters/formatters (prettier + eslint + solhint). +Continuous Integration and Continuous Deployment are handled via GitHub Actions. +The CI process includes Lint, Compile, Unit tests, and Coverage checks. +The CD process is still being defined. + +## Communication + +All project communication is done through Discord. +This includes general discussions, updates and decision-making. +Please ensure you have joined our Discord server to stay updated and participate in the project discussions. + +## Bugs + +If you encounter a bug, please report it through GitHub issues. When reporting a bug, please provide a clear description +of the issue, steps to reproduce it, and if possible, a proposed solution or fix. +This will help us address the issue more effectively. + +Please use the `bugfix/slug-name` branch for developing bug fixes. diff --git a/README.md b/README.md index 15dd8094..d30f6cb7 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,22 @@ -## Verax +## Verax Attestation Registry **Verax, previously known as "Linea Attestation Registry", is a set of contracts that allows anyone to read and write attestations of any type and any subject.** +

+ Verax Logo +

+ +## Contribution + +Verax Attestation Registry is a community-led initiative, with developers from various companies and different +backgrounds. While we are more than happy to get help from multiple sources, we need to rely on strong Ways of Working. + +Don't hesitate to check our [Contribution Guide](./CONTRIBUTING.md) before pushing your first code to the repo! + ## Contracts addresses -### Testnet +### Linea Testnet - Router = [0x736c78b2f2cBf4F921E8551b2acB6A5Edc9177D5](https://goerli.lineascan.build/address/0x736c78b2f2cBf4F921E8551b2acB6A5Edc9177D5) @@ -20,7 +31,7 @@ attestations of any type and any subject.** - AttestationReader = [0x65c8294C7aF0f0bDDe51eF92AF850613bb629fc6](https://goerli.lineascan.build/address/0x65c8294C7aF0f0bDDe51eF92AF850613bb629fc6) -### Mainnet +### Linea Mainnet - Router = [0x4d3a380A03f3a18A5dC44b01119839D8674a552E](https://lineascan.build/address/0x4d3a380A03f3a18A5dC44b01119839D8674a552E) @@ -35,9 +46,7 @@ attestations of any type and any subject.** - AttestationReader = [0x40871e247CF6b8fd8794c9c56bB5c2b8a4FA3B6c](https://lineascan.build/address/0x40871e247CF6b8fd8794c9c56bB5c2b8a4FA3B6c) -## Relationship schemas id's - -### Testnet & Mainnet +## Relationship Schemas IDs (testnet & mainnet) -- Relationship schema id = 0x89bd76e17fd84df8e1e448fa1b46dd8d97f7e8e806552b003f8386a5aebcb9f0 -- namedGraphRelationship schema id = 0x5003a7832fa2734780a5bf6a1f3940b84c0c66a398e62dd4e7f183fdbc7da6ee +- **Relationship** Schema ID = `0x89bd76e17fd84df8e1e448fa1b46dd8d97f7e8e806552b003f8386a5aebcb9f0` +- **namedGraphRelationship** Schema ID = `0x5003a7832fa2734780a5bf6a1f3940b84c0c66a398e62dd4e7f183fdbc7da6ee` diff --git a/doc/verax-logo-circle.png b/doc/verax-logo-circle.png new file mode 100644 index 0000000000000000000000000000000000000000..c5b785988ad02883712da6f19931d3c150bef893 GIT binary patch literal 7681 zcmXY0Wk6H!+uj(R3IdV_>5vd4q@@`h8>2^eNlJ%+v`9Ay2yATR=om;yNXY@Be<-*@ttU>$&T>&$+KFL0?y$hLV*M007WvYN!|z{!xS2ezH6xj!@jVi&6Bw{b6?5k;QpBfJsp!8o*mcg9y zeVa3MWtz$}pFi`rF|l94Yo*(y_IB67K`{&5K>hbO?b@BV23>!UZaV}F-R%FV|XsmV14 z#KxOP2lfVx3LG*{^zz(PmO~X4~jyPE%0H(3Ok4Ita?*YOzYMHv?CKJs2Pa3DJwPkbyyR4Z4H#}bBj_Y zEjDW^pSsdxpF;8zW%<#f38WQ|d2TYOCS>wf>Z=6ZVz^B=;P`xDVZo|yZQWA%JlOi; zM_P!}w!G8f#Bzw!;mT!3+zQ8>jPK;H@uTbTwNsg1E{*Xf8v9F0qJqdXoEbvAo)S*+ zkSv=hDUuVx9z=DUL>I^x^#ylx{f76AAh{gjeLc0gf&_bVi?S~21=5Phq$sMWU%;;A zCkV-7Q4#WeA}fu%x(NT6({7wNt}`kSxVO0OK?9rwMgWQ@wy5-Y>L+xhT7gGo7|<%& z!zA1iC$Jd63F7>)Mb$|U|3dW@k4wSP;3^-rRTSZradp1G`p=2yzJeCXmZ_JCEjYet ztm#vD0?jFSyA_vS+{g?I>ywXub*J&^WS;=5+PQlFgG? zGJ5zD*_6;-s!-Op`!=(VGLe^&p+eTV5QGO!1qTk`EtAig5BFFixgvkRbrPFLJa??v zP16Q?&rLnCn24hzSn-FVwomEz&GjZt?Ok*25HBI?pE^XS-dCO=d9vkfk?qbEx~sdC zNz`vX+&dt?){U@u<;|GO0qP+O70waXZrv-`cec~7BfGZLD`n!5C2>vqF}1s^E$v?m zXI(A`f_c3XBJLp$y_uWieXBzU@Rul*FGsjgQx+vtJrBItZE$hw*U_qFXk&VBKU1?| z>*5_jgyNW;1YO)nyPqMoz_hNM=jYl1XAR}006o@_1X-(^M?q@k4&>L(+e2;E3eRdm zpRN@?HchcHa4s&+C`xDOa(FtN;HQ=Jy~ui~y0~oa(YFBGgfeuC9%PdSjwgsH3d{cL zxYl@>AHeKwvJm@-<6cY$=}+4H_a$(@1GDvLZRxYnhR0G&GVn8=j}fHuS>yf>_bCy| zyhXw7a8_APHaJ=1pCe!o$(5?;a6_Y3WUIqWP1xYfy8fmO$NO{Znvhuqoo$Ki7LtY6 znpIZdY|?lxsy)S)ze?*%+&p1Ettq&CZE5JkY|^!t?EkE13>H0`winuY;Xwi;1YtO- zvhVv{D@BUq4-p`bKo?uzVfnJj5I@;}7-KjEZeK~hgB3zl-VmaKJg~vHDzDM_@tjIH z9T0H+O9^qux75?xU)Cv^?^zd(&lk1`t-scm#+DPTpAGnTXA;ztHkTsYFaRS$iG7<@ z4(G85=Y?C7$QOPpDo7%|*HYMLV0{lg-oSeZ;igK)Fjm$M(Wmuk6Nb@bgzk z(<|Zpyp`5JP2$Z5YE>;y?TjPb9Us{<6QaSFkG^-zMg5cB+u(MLaHR^QhOX=T^szNs zb~M6#)EQ*PS+za(Y}J5W1( zHbd~Lk>IP4AN*|TZ|_b0B;QsF5e308mY*lgH=jDkaPX}S^JZyQae6#vcjl#TWAH#J z^E2qTce8l<%=qoOt=n|1w6E?iiai!tJEW2H>>V0$aIf%icNCXm^YiRK{g(tiqQAFD ztA|P|2OWNfTre=v*`Bc;e6jJcv*%zQe&l|AXw)4Za{F!<-GmGwVylEgbyD1op_tvm z{e5!~O{n}GrtY*4lw2k49J4>Xq zXXe`|5pW6l3MZvz7_HAeZ_%51_`I(>Z-iomp*IZlK-E9=$DYXx z@8jy?VMpRNi5%e|S~AB1M3}_O{k0&O99-EvuM(&aMftBe?pxu zsMAqf8oe1Ueo92bxc>fH)6sGCOIb?BY+dhF_PE`~b42zx*}Uv)k<0(D{&mK&yB zbW13!4*qogipH`rifUx%hgs&h>NOze?nJmqgL%OolX`RpggfDLh{MS9yWh#Z&^J>Cq zCK;rw^Dn$f=XO>5$;sHc`5%}@Y+T`nx3+flTuPCKRB6ra4&K_m(S8w+fv8 zXn!4ffgIGb`NWe`WYWHpCHHa{o`fh$T6e~-`9FqBcM_w1M|)U@1lz|MdFeWrj_#5% zgDP@m-Hpy!tPzA9M!Zt&y!zzjv*mPg^h9Qf@%0b`+J8my$w(uw*-UfCN0sC`Ja zo-5lV{E+$t{6<)YhMX>T#j+wkuW%)Ix!QNG*@>px3t9V~7tBW+pW*Bu(5HF?H>Ch+ zf2u>jeh_rD%QTi_w}02;nbOJUJ87&#ec#O7tbIWZtDrzeJCM#ZN0lH!P5k;kJ>s&N5wP7?$JM%xz{ER z&@r-C3YET+Zj-@O^-|uP9CZd?tzaRaajUIAfYht7GygaIQV(e}wKm6BhrCws1}1m~ zb~a&)8$ZvOOQhZNL3TW5c}6xU{nMlEw*(lt!s>l>*C^Awm7DMTyt_~{_u76WS`DiL zYnc5YF8$&nM_?K&Y!ej>O<{#$eIjn4ilwf&@%wkgV9IW)3gY3^`G~x{0Ng+Q{A3OR z2DdWVJy>)TPKj;dTx)GWu@Y5p_kV#byPCzFee9GDf+7ex^z$PYHgO@5jWh2RnT*Hj zw|(w+%}|xk=@g`Idp=j-oMoyEG{`d2<)qnxPZ!5h7PJ)auv5Z!RliSnN-GQBR9qWE z>;ZWBxGSCLV4g>;g~63j5;FrJmX)6Pba%&FG%z zkM02dM+0ba+llRdn5Gk7l-JP{Inj4t-@k~F^e1A}3S#=2I44@9ZUV1!t5NsA%B1vt z!$aI@%}#^XwMH>l-)xo0b8Z(R0=P*EmX?bVw99f~~9x+1Cjr zvV6}^;ZmY=jf_R(dj`v2U{_kr6%U#yt2$hVo5%zbvc8|!a&XgPoQ; zxk=rIJ2Ts+OVxH*kw5cY(Qm?he@vN9^f0C-<2x}_st8QBB-*)M#-uJG8;UV&;#u$z zK!QJA4*-oGK}d8}b4CB|8VcBO!(g356muwNb>CMFqkH&xYdUqNulu*UzMNQvJWX<$ z-`l5b^02}y?p={YGoqr`sHNltKXA@g5F;o+NCESE&!KENYVbODHu+cqRFgDhvpis!N(SH=GoF9 z^|*dQC&~8nULE~4(coI7kC3p!mMc@q^k<_oSvy=`KFi8*(5~P0h+=AGL}Em+vh%KZ9ddO3$YOzn{V{1iFAfH)J&Eie?Ti)mc6Et*Vp>TVYN0;M}6 z+8Khb%HB*(J{$f#4RI+QXg7ig&VxDfFU?B!mTnP>JJpFUUk>?s(^44)I=1D7w@x2! z8w;1xeLY@X53%chZkzAx*0 z*jo~zfP$NINlUNw;#J0k?D~$UScWD^1?*_LB{q`t!aiV0D})kquASyQ^OzGYw#aL2 z$#Um-VQQTVA|kXDbi8FRxnYo9>gHYJ!2EoEpX1} zXl-xHEDHA1_{V5A+9L^R{s#Ju0XYV*OBEGkNKO{-@|y9%sHCK2Icd{8gHElE8ej~& zMxf0t8yAGO5s^dW?s*x6pDxeeBXNAYv2gD%1Nz$oet9wbbiFeL1WOAzhp%?L%N(rj;@9_J)oMmlVr8S{Fb}ZlK`bfEsf%Y^KiBW zp8mHgm=OUbwghkUdTvwCrST5fafua5g}-$St7_HpJ8TY^WT@TO*#xJxK!7k6QfQj! z+^R{lGFyHYs!&l-SkE>Wfs#Zrf(kZ~Xt@N7trZx5vtJBCM0D=QE%rN}veWreJFi|X z$f87wavUguySj}k2Hf3j^zE)pE!x0rHOha8hrIT+T$fdV3-?dWaYD6{5eC*6B3PZZ zVql;#61CVrC_KNX=y=uCS}{#WJeO)rAJy;-u*0oLH4io>m@*H z<`~gMC6cfAMq$cB(#wh$*>>@7^YZ%i7d8$p4=57EP_TB_kw#r6VXA;7i1sG9{EQzL zwE45vB&9OK7qNDmVaGAYS?pe>QVpwei4U?YkawQ6)BvTuxtXm_z!e zLFcN`8N+Y$@`+W`^aKQ;L;8SaW}xf{w2u&w@?Eebn_=Xi^qr6IvOVq**LAxqXt`ZX z+yqrnDj9$k1m@uJ_r{-Bax{euy}+ekNqx^$apT zih^w+SFv*AM+rR^c-y!O!X#63vRz_gyJIQ9`L4FTIM^<+RTrhLt8sq7S;K3rrXOom zGV>`I+V6qo)N7~YDsg~Yr;;FP(<9H$1&P_i!wlDc+aAARJVMI33y#LlZ-Gs}W2l%& zA~u7^x4_Av+3L?sx;6o(JWxpe{&$78BkIKasA4r3Me7|in1_c!R=Ohq2!R*j<^+7^4GBOdkb#$hnJ5XKXIXl%jT!R2rUoTEuS4GaMMH2oB$n~5Z;5P_ zt48f-ZWC+*wCyn|bn=E6gOV|AmB?VD(pQ$4Vu|;=T`YT4IJWAyb|l=j6zC2}LX(BV z7XsGDff?j(B$?s^UU!4w~^O{|uHh zKq*LS)m_uANBV=S;q^w8%$w7%)F`W{Gm%GOS-Q>BD7ZsC^@g2ziswSK__8$dBAGDgy>I;Z@IF01QhF@}qTomp{g=7HQ3k z=oqY`Rmb$oxnK{Q{uu7mW1L8Sszz6}-YyL(MnJ9aoBVQ5y?WA5c>J0zNWN@_hgf75 z_z$La$N##k54kkSpva*FQ09od(dT8Jr;LaCx1&h*Km*l7c!fH%FpSqqXvYpAd1(@a zK|lshV8v|Ks}fB7^=b*98OdSPnL(pa1$=t}mawtrXJ`=vif2sPlwJwtUop19HpFT1 z{S|8W1jaCD(R2Lp7@<@x*Faf`|D8cb{iz!pkkvKhrn$ugcuUa9-8zWGiu5so)H0&1|^xFCi!)~SwX*v{4Kr#sf;Ro(^kZlM3|Oi&lCtmtt8v8_z#(F zYcv*A?zs$}(EO^ZE~IHstN>*-{jHjd+1HITPFneY?R@%%dL1&$Zw*&K7MhV7gGe$z zPu9jb|6E&_;~?Imd?NWr-=KtYobhz^-J4B96GlrP*!{h zI1AH+HU)i>Ayn17dp%Yw-s_(0R6YYxv)APie#BJ6_~dh%@E2cGLVuDd;s~pY<*DDr9gbEQfsdo$Z_Tap>17gr z3eoKdMNSm8#=g{cIFo$#EBfecGU}ESlU9r#f%`m-3}i6!jhPcn@(&53u;==$Gj?9r z9=hT7^vZ?@C;3Nb-DzOCkc~l7VCp5mQlk9Y8ue}(8SEUxXCX{v9*On^ndOL-dd7Ri zi`)$ksR<_wCA^c_6WME}>%9o<@O&gyRLZ!4+uL^mD*Hao{(lweY7fbOg9+8XK`2); zcvZ-!fzJ+UUn!vLe8vGUe8m4T(**7s2q&?4J?`bcpMx{;{iVboZyfl-9~w;4_ZOHn zMQKf+)bap!0CMC}XU=W&VqIQSBQWf%fA3N$DNlueP*6vA#rz)#bslqx7PKF~KP((Qn2# z;W}@ITVmv>LxpmLn?KaZaU49BCb)G?py~w>q-~TDN$(g=9T{+~QN1Gsy=CcJ3icp+ zjX;+Nuj{VIP$-mr;=-+j@8=|TJNaw$gwqxRh42~m1JMn3&WqoyFHJuwILV?0$NndI zcyIkDc@QKa*9%G3nvN0zhoT-i$y*lX)p`{|C}XcTCvjY+6%vFv{3oT1e~|Ad3eO#5 zK1^F=OLJGJC$TT3K8zCVWm=!(ev2NcP$0NLH?S40!tUg9cPWCy%;}vTK+czZ%BNW;gl>HM zRwnV>d1MP+8%rBSoAgjl2giYaH<=qpR56Z~!@Evx&o2nHcwc$egYWppVtdunPCxqu z3tVvB6SPWaLDoeFXNqc-Ba#KmlFG7@+*F7Xza6wjWf3#?blcKd#>d=48Rv_;6In%Y z*2p)km>yoVu|jSU_jc`VWYTo-9b%t>_5bN&FW<)Zyc%OZ=MziEEj}FhPit#lT!K0a z%IAQzrYSvxe~e!VB5p~M6cVR`)FYK~PuI_gAxGzbM`&&iFutcj5+p=`rmC(AMhOx9 Ee^)}YB>(^b literal 0 HcmV?d00001