-
Notifications
You must be signed in to change notification settings - Fork 83
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
Enhance aries_vcx
crate readme
#1043
Conversation
Signed-off-by: Patrik Stas <[email protected]>
aries_vcx
crate readme
Signed-off-by: Patrik Stas <[email protected]>
Codecov Report
@@ Coverage Diff @@
## main #1043 +/- ##
=====================================
Coverage 0.05% 0.05%
=====================================
Files 384 384
Lines 21249 21249
Branches 3835 3835
=====================================
Hits 12 12
Misses 21236 21236
Partials 1 1
Flags with carried forward coverage won't be shown. Click here to find out more. |
Signed-off-by: Patrik Stas <[email protected]>
I think this is a nice change. It gives a more clear and relevant at glance view to someone approaching The change to underscores is welcome consistency. And should offer slightly lower cognitive effort keeping track of delimiters. On the other front, I think we could do more to differentiate aries-vcx (project) vs Is it feasible and appropriate to rename the project as "Aries VCX" / "AriesVCX" ? ACA-Py for example has hyphenated repo but title case project name. Similarly with Firefly. |
A long time ago we came to agreement we will call the repo "aries-vcx", there was a time of many inconsistencies...at the time of that decision, the repo was pretty much ONLY |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change sounds good to me!
aries_vcx
crate readmearies-vcx
package toaries_vcx
, looking at most of are other crates, it seems that underscore is "the way" :-) I like it thoughAlso want to point out the distinction between
aries-vcx
andaries_vcx
:aries-vcx
being name of the HL project currently containing variety of useful components, not particularly tied to aries itself - such as cratesdid
,did_doc
,did_peer
and number of othersaries_vcx
is the main, but also just one of many crates in the repo