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

Adds comments to example contracts, improve example contracts documentation #570

Merged
merged 9 commits into from
Oct 22, 2024

Conversation

poppyseedDev
Copy link
Contributor

Closes #555
Mentions #556

@poppyseedDev
Copy link
Contributor Author

Note: there is a dead links error for https://github.com/zama-ai/fhevm/blob/main/examples/README.md, however this will not be an error anymore once this PR will be merged.

@jatZama
Copy link
Member

jatZama commented Oct 10, 2024

Firstly, can you rebase interactively and squash all your commits to get a unique clean commit instead of 14?

examples/README.md Outdated Show resolved Hide resolved
examples/README.md Outdated Show resolved Hide resolved
examples/README.md Outdated Show resolved Hide resolved
examples/README.md Outdated Show resolved Hide resolved
@poppyseedDev
Copy link
Contributor Author

Firstly, can you rebase interactively and squash all your commits to get a unique clean commit instead of 14?

@jatZama I managed to squash only a portion of them, for the remaining few I get the following error:

Unable to squash. Squashing replays all commits up to the last one required for the squash. A merge commit cannot exist among those commits.

@jatZama
Copy link
Member

jatZama commented Oct 14, 2024

Firstly, can you rebase interactively and squash all your commits to get a unique clean commit instead of 14?

@jatZama I managed to squash only a portion of them, for the remaining few I get the following error:

Unable to squash. Squashing replays all commits up to the last one required for the squash. A merge commit cannot exist among those commits.

how do you do the squash?
I use git rebase -i HEAD~X where X is the number of commits i want to squash

docs: payment-limit docs

docs: blind auction

docs: improved the comments on example contracts, use of @dev, @params and @notice

docs: readme is updated

docs: imporved readme for examples

docs: improve README

docs: prettier

docs: commit suggestions

docs: shortended readme
Copy link
Collaborator

@yuxizama yuxizama left a comment

Choose a reason for hiding this comment

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

Thank you so much for the updates!
@poppyseedDev
Could you merge this PR also into the x0.5 branch? Otherwise it won't be reflected in the documentation website, especially in the "see-all-tutorials.md" where the links to "Governor DAO" and "Decentralized ID" are dead.

@poppyseedDev poppyseedDev merged commit 638d36f into main Oct 22, 2024
2 of 4 checks passed
@poppyseedDev poppyseedDev deleted the example-docs branch October 22, 2024 13:04
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.

adding comments + documentation to the contracts that we already have
3 participants