Optimism ID is the result of a Mission Request from the optimism community. The goal of this mission is to provide applications on Optimism with a toolkit that enables trusted, secure relationships between apps and users, emphasizing self-sovereign identity and privacy. While Privado ID is technically chain-agnostic, it was primarily designed for Polygon and required some adjustments to function on Optimism. Optimism ID is a fork of Privado ID, specifically tailored to simplify the implementation of the ZK identity toolkit on the Optimism network.
You can find all the repositories tailored for Optimism ID at wakeuplabs-io/opid
Privado ID Documentation is the documentation hub providing extensive documentation, community resources, and guides for enthusiasts and developers interested in learning about or building solutions using Privado ID.
After running the docs locally on your machine, use a code editor to apply your changes before submitting your PR. Note that you must have a GitHub account and an understanding of Markdown syntax.
-
Create a new branch for your changes.
git checkout -b [new_branch_name]
-
Commit your changes. In the commit message, please reference the issue it resolves. For help, see GitHub Docs: Linking a pull request to an issue using a keyword.
git commit -m "brief description of changes"
-
Push to your forked repository.
git push
-
Submit a PR against the
main
branch of thewakeup-labs/opid-documentation
repo. -
Add a title to your PR with appropriate labels.
For example, if you want to suggest edits to the "Develop" page, name your PR: update: develop.md.
-
Add a description to your PR. Please reference the issue it resolves.
For help, see GitHub Docs: Linking a pull request to an issue using a keyword.
-
Write a brief description of the changes you have made. If possible, include screenshots and references.
-
Create a new issue to report a bug, request a feature, or suggest changes.
-
Comment on the issue if you want to be assigned to it so our team can assign the issue to you.
-
If you do not have a specific contribution in mind, you can also browse current issues.
-
Issues that additionally have the
good first issue
label are considered ideal for first-timers.