Skip to content
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

add snarkyjs-pack community package to README.md [now with provable tests and doc comments!] #1040

Merged
merged 3 commits into from
Sep 19, 2023

Conversation

barriebyron
Copy link
Contributor

@barriebyron barriebyron commented Jul 20, 2023

This PR adds our second community package for o1js to the README

https://discord.com/channels/484437221055922177/915745847692636181/1131617947534753962

@barriebyron barriebyron self-assigned this Jul 20, 2023
Copy link
Contributor

@ymekuria ymekuria left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Exciting to see more community packages!

Copy link
Collaborator

@mitschabaude mitschabaude left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just making sure -- did someone review the library?

@Trivo25
Copy link
Member

Trivo25 commented Jul 23, 2023

I just took a quick look. It would be good if the package could add an e2e integration test (demonstrating the functionality in a smart contract, or other provable code). Additionally, I couldn't find any doc comments (which would be a nice to have!) cc @45930

@45930
Copy link
Contributor

45930 commented Jul 23, 2023

@Trivo25 yeah I will plan to do that after my cohort 1 presentation. I am busy working on that for the next couple weeks.

@45930
Copy link
Contributor

45930 commented Jul 23, 2023

@mitschabaude no one has reviewed thoroughly AFAIK

@Trivo25
Copy link
Member

Trivo25 commented Jul 24, 2023

@Trivo25 yeah I will plan to do that after my cohort 1 presentation. I am busy working on that for the next couple weeks.

That's fine! It's not a must, but would be great if you want to be listed as a community package in SnarkyJS :)

@barriebyron
Copy link
Contributor Author

@mitschabaude I see you approved, because I am uncertain about the technical status, would you be up for merging this PR when you feel the package meets the high quality package guidelines? Another option, we label it as experimental?

@mitschabaude
Copy link
Collaborator

@mitschabaude I see you approved, because I am uncertain about the technical status, would you be up for merging this PR when you feel the package meets the high quality package guidelines? Another option, we label it as experimental?

I only approved to no longer be "requesting changes" 😅 I think the comment by Florian still makes sense, we want those packages to have a test

@barriebyron
Copy link
Contributor Author

Excited about our second package candidate. We'll leave this PR open as we await package updates from @45930

@barriebyron barriebyron changed the title add snarkyjs-pack community package to README.md add snarkyjs-pack community package to README.md [wait for updates] Jul 28, 2023
@45930
Copy link
Contributor

45930 commented Sep 19, 2023

Hi guys. I added provable tests and doc comments, as well as rebranded everything to "o1js".

https://github.com/45930/o1js-pack/blob/main/src/lib/PackingPlant.ts
https://github.com/45930/o1js-pack/blob/main/tests/provable/end_to_end.test.ts

@barriebyron barriebyron changed the title add snarkyjs-pack community package to README.md [wait for updates] add snarkyjs-pack community package to README.md [now with provable tests and doc comments!] Sep 19, 2023
@barriebyron
Copy link
Contributor Author

barriebyron commented Sep 19, 2023

ready to merge, thank you @45930 for your contribution and community package

I contributed 45930/o1js-pack#14 for your package README

Consider me your friendly package editor!

README.md Outdated Show resolved Hide resolved
@barriebyron barriebyron merged commit 0bc7995 into main Sep 19, 2023
13 checks passed
@barriebyron barriebyron deleted the barriebyron-patch-1 branch September 19, 2023 18:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants