Skip to content

Improve documentation for @semaphore/hardhat package #772

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

Merged
merged 2 commits into from
May 7, 2024
Merged

Conversation

0xjei
Copy link
Contributor

@0xjei 0xjei commented May 7, 2024

Description

This PR aims at improving the documentation (code / README) for the @semaphore/hardhat package.

Related Issue(s)

see #483

Other information

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have run yarn format and yarn lint without getting any errors
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Copy link
Member

@cedoor cedoor left a comment

Choose a reason for hiding this comment

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

LGTM! Just a comment :)

@@ -2,7 +2,7 @@
<h1 align="center">
Semaphore Hardhat plugin
</h1>
<p align="center">A Semaphore Hardhat plugin to deploy Semaphore contracts.</p>
<p align="center">A Hardhat plugin to deploy Semaphore contracts.</p>
Copy link
Member

Choose a reason for hiding this comment

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

Could you update the package.json description as well?

@0xjei 0xjei requested a review from cedoor May 7, 2024 13:10
@cedoor cedoor merged commit 1b34ad3 into main May 7, 2024
5 checks passed
@cedoor cedoor deleted the docs/hardhat branch May 7, 2024 13:27
FaezehShakouri pushed a commit to FaezehShakouri/semaphore that referenced this pull request Feb 1, 2025
…tocol#772)

* docs(hardhat): improve code comments and readme for @semaphore/hardhat package

* docs(hardhat): update package.json description
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.

2 participants