Skip to content

Latest commit

 

History

History
78 lines (56 loc) · 2.95 KB

CONTRIBUTING.md

File metadata and controls

78 lines (56 loc) · 2.95 KB
Raw

Contribution Guidelines

Hello! 👋 Thanks for your interest in joining the mission to accelerate the mass adoption of crypto for personal sovereignty! We welcome contributions from anyone on the internet, and are grateful for even the smallest of fixes!

Ways to contribute

There are many ways to contribute to ZKsync SSO SDK:

  1. Open issues: if you find a bug please open an issue.
  2. Add detail to existing issues: provide screenshots, code snippets, etc issues.
  3. Resolve issues: either by showing an issue isn't a problem or by fixing the problem and opening a PR.
  4. Report security issues, see our security policy.
  5. Join the team!

Fixing issues

If you would like to fix an issue, please begin with commenting and getting yourself assigned to the issue in Github. Your contributions should come from a fork of the project. Refer to the Github guide on how to work with PRs created from a fork.

Commit conventions

This project uses Conventional Commits standards. For changes that are code related, use the chore:, fix:, feat:, or docs: tags in your commits.

git commit -m "docs: fix typo in guide"

Signed git commits

Your git commits need to be signed with a verified signature.

  1. Follow the instructions to generate a signing key.
  2. Add the key to your GitHub account.
  3. Tell git about your signing key.

Licenses

If you contribute to this project, your contributions will be made to the project under both Apache 2.0 and the MIT license.

Resources

We aim to make it as easy as possible to contribute to the mission.

  1. In-repo docs aimed at developers
  2. ZKsync docs
  3. Company links can be found in the repo's readme

Code of Conduct

Be polite and respectful. Read our Code of conduct.