-
Notifications
You must be signed in to change notification settings - Fork 114
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into add-docker-compose-config
- Loading branch information
Showing
6 changed files
with
198 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,20 @@ | ||
# What :computer: | ||
* First thing updated with this PR | ||
* Second thing updated with this PR | ||
* Third thing updated with this PR | ||
# What ❔ | ||
|
||
# Why :hand: | ||
* Reason why first thing was added to PR | ||
* Reason why second thing was added to PR | ||
* Reason why third thing was added to PR | ||
<!-- What are the changes this PR brings about? --> | ||
<!-- Example: This PR adds a PR template to the repo. --> | ||
<!-- (For bigger PRs adding more context is appreciated) --> | ||
|
||
# Evidence :camera: | ||
Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended | ||
## Why ❔ | ||
|
||
<!-- All sections below are optional. You can erase any section not applicable to your Pull Request. --> | ||
<!-- Why are these changes done? What goal do they contribute to? What are the principles behind them? --> | ||
<!-- Example: PR templates ensure PR reviewers, observers, and future iterators are in context about the evolution of repos. --> | ||
|
||
# Notes :memo: | ||
* Any notes/thoughts that the reviewers should know prior to reviewing the code? | ||
## Checklist | ||
|
||
<!-- Check your PR fulfills the following items. --> | ||
<!-- For draft PRs check the boxes as you complete them. --> | ||
|
||
- [ ] PR title corresponds to the body of PR (we generate changelog entries from PRs). | ||
- [ ] Tests for the changes have been added / updated. | ||
- [ ] Documentation comments have been added / updated. | ||
- [ ] Code has been formatted via `zk fmt` and `zk lint`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
name: Node license check | ||
|
||
on: pull_request | ||
|
||
env: | ||
ALLOWED_LICENSES: > | ||
MIT; | ||
BSD; | ||
ISC; | ||
Apache-2.0; | ||
MPL-2.0; | ||
LGPL-3.0; | ||
LGPL-3.0-or-later; | ||
CC0-1.0; | ||
CC-BY-3.0; | ||
CC-BY-4.0; | ||
Python-2.0; | ||
PSF; | ||
Public Domain; | ||
WTFPL; | ||
Unlicense; | ||
# It has to be one line, there must be no space between packages. | ||
EXCLUDE_PACKAGES: [email protected];[email protected]; | ||
|
||
jobs: | ||
generate-matrix: | ||
name: Lists modules | ||
runs-on: ubuntu-latest | ||
outputs: | ||
matrix: ${{ steps.set-matrix.outputs.matrix }} | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- run: | | ||
DIRS=$(find -not \( -path \*node_modules -prune \) -type f -name yarn.lock | xargs dirname | awk -v RS='' -v OFS='","' 'NF { $1 = $1; print "\"" $0 "\"" }') | ||
echo "matrix=[${DIRS}]" >> $GITHUB_OUTPUT | ||
id: set-matrix | ||
license-check: | ||
needs: [generate-matrix] | ||
runs-on: ubuntu-latest | ||
strategy: | ||
matrix: | ||
dir: ${{ fromJson(needs.generate-matrix.outputs.matrix) }} | ||
steps: | ||
- name: Checkout latest code | ||
uses: actions/checkout@v3 | ||
|
||
- name: Use Node.js | ||
uses: actions/setup-node@v3 | ||
with: | ||
node-version: 18 | ||
|
||
- name: Install yarn | ||
run: npm install -g yarn license-checker | ||
|
||
- name: Install dependencies in ${{ matrix.dir }} | ||
working-directory: ${{ matrix.dir }} | ||
run: yarn install | ||
|
||
- name: Check licenses in ${{ matrix.dir }} | ||
working-directory: ${{ matrix.dir }} | ||
run: npx license-checker --json --onlyAllow="$ALLOWED_LICENSES" --excludePackages "$EXCLUDE_PACKAGES" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# 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 the ZK Stack: | ||
|
||
1. Open issues: if you find a bug, have something you believe needs to be fixed, or have an idea for a feature, please | ||
open an issue. | ||
2. Add color to existing issues: provide screenshots, code snippets, and whatever you think would be helpful to resolve | ||
issues. | ||
3. Resolve issues: either by showing an issue isn't a problem and the current state is ok as is or by fixing the problem | ||
and opening a PR. | ||
4. Report security issues, see [our security policy](./github/SECURITY.md). | ||
5. [Join the team!](https://matterlabs.notion.site/Shape-the-future-of-Ethereum-at-Matter-Labs-dfb3b5a037044bb3a8006af2eb0575e0) | ||
|
||
## Fixing issues | ||
|
||
To contribute code fixing issues, please fork the repo, fix an issue, commit, add documentation as per the PR template, | ||
and the repo's maintainers will review the PR. | ||
[here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) | ||
for guidance how to work with PRs created from a fork. | ||
|
||
## 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. This is still WIP, and we're happy for contributions | ||
and suggestions here too. Some resources to help: | ||
|
||
1. [In-repo docs aimed at developers](docs) | ||
2. [zkSync Era docs!](https://era.zksync.io/docs/) | ||
3. Company links can be found in the [repo's readme](README.md) | ||
|
||
## Code of Conduct | ||
|
||
Be polite and respectful. | ||
|
||
### Thank you |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
# Security Policy | ||
|
||
We truly appreciate efforts to discover and disclose security issues responsibly! | ||
|
||
## Vulnerabilities | ||
|
||
If you'd like to report a security issue in the repositories of matter-labs organization, please proceed to our | ||
[Bug Bounty Program on Immunefi](https://era.zksync.io/docs/reference/troubleshooting/audit-bug-bounty.html#bug-bounty-program). | ||
|
||
## Other Security Issues | ||
|
||
We take an impact-first approach instead of a rules-first approach. Therefore, if you believe you found the impactful | ||
issue but can't report it via the Bug Bounty, please email us at | ||
[[email protected]](mailto:[email protected]). | ||
|
||
### PGP Key | ||
|
||
The following PGP key may be used to communicate sensitive information to developers: | ||
|
||
Fingerprint: `5FED B2D0 EA2C 4906 DD66 71D7 A2C5 0B40 CE3C F297` | ||
|
||
``` | ||
-----BEGIN PGP PUBLIC KEY BLOCK----- | ||
mQINBGEBmQkBEAD6tlkBEZFMvR8kOgxXX857nC2+oTik6TopJz4uCskuqDaeldMy | ||
l+26BBzLkIeO1loS+bzVgnNFJRrGt9gv98MzNEHJVv6D7GsSLlUX/pz7Lxn0J4ry | ||
o5XIk3MQTCUBdaXGs6GBLl5Xe8o+zNj4MKd4zjgDLinITNlE/YZCDsXyvYS3YFTQ | ||
cwaUTNlawkKgw4BLaEqwB2JuyEhI9wx5X7ibjFL32sWMolYsNAlzFQzM09HCurTn | ||
q0DYau9kPJARcEk9/DK2iq0z3gMCQ8iRTDaOWd8IbSP3HxcEoM5j5ZVAlULmjmUE | ||
StDaMPLj0Kh01Tesh/j+vjchPXHT0n4zqi1+KOesAOk7SIwLadHfQMTpkU7G2fR1 | ||
BrA5MtlzY+4Rm6o7qu3dpZ+Nc4iM3FUnaQRpvn4g5nTh8vjG94OCzX8DXWrCKyxx | ||
amCs9PLDYOpx84fXYv4frkWpKh2digDSUGKhoHaOSnqyyvu3BNWXBCQZJ20rqEIu | ||
sXOQMxWIoWCOOPRRvrHrKDA2hpoKjs3pGsProfpVRzb9702jhWpTfbDp9WjQlFtX | ||
2ZIDxlwAxcugClgrp5JiUxvhg2A9lDNwCF7r1e68uNv5usBZQVKPJmnvS2nWgKy8 | ||
x9oJsnwrEjxwiRHd34UvfMkwY9RENSJ+NoXqBdS7Lwz4m6vgbzq6K56WPQARAQAB | ||
tCRaa1N5bmMgU2VjdXJpdHkgPHNlY3VyaXR5QHprc3luYy5pbz6JAk4EEwEKADgW | ||
IQRf7bLQ6ixJBt1mcdeixQtAzjzylwUCYQGZCQIbAwULCQgHAgYVCgkICwIEFgID | ||
AQIeAQIXgAAKCRCixQtAzjzyl5y8EAC/T3oq88Dak2b+5TlWdU2Gpm6924eAqlMt | ||
y1KksDezzNQUlPiCUVllpin2PIjU/S+yzMWKXJA04LoVkEPfPOWjAaavLOjRumxu | ||
MR6P2dVUg1InqzYVsJuRhKSpeexzNA5qO2BPM7/I2Iea1IoJPjogGbfXCo0r5kne | ||
KU7a5GEa9eDHxpHTsbphQe2vpQ1239mUJrFpzAvILn6jV1tawMn5pNCXbsa8l6l2 | ||
gtlyQPdOQECy77ZJxrgzaUBcs/RPzUGhwA/qNuvpF0whaCvZuUFMVuCTEu5LZka2 | ||
I9Rixy+3jqBeONBgb+Fiz5phbiMX33M9JQwGONFaxdvpFTerLwPK2N1T8zcufa01 | ||
ypzkWGheScFZemBxUwXwK4x579wjsnfrY11w0p1jtDgPTnLlXUA2mom4+7MyXPg0 | ||
F75qh6vU1pdXaCVkruFgPVtIw+ccw2AxD50iZQ943ZERom9k165dR9+QxOVMXQ4P | ||
VUxsFZWvK70/s8TLjsGljvSdSOa85iEUqSqh0AlCwIAxLMiDwh5s/ZgiHoIM6Xih | ||
oCpuZyK9p0dn+DF/XkgAZ/S91PesMye3cGm6M5r0tS26aoc2Pk6X37Hha1pRALwo | ||
MOHyaGjc/jjcXXxv6o55ALrOrzS0LQmLZ+EHuteCT15kmeY3kqYJ3og62KgiDvew | ||
dKHENvg7d7kCDQRhAZleARAA6uD6WfdqGeKV5i170+kLsxR3QGav0qGNAbxpSJyn | ||
iHQ8u7mQk3S+ziwN2AAopfBk1je+vCWtEGC3+DWRRfJSjLbtaBG8e6kLP3/cGA75 | ||
qURz6glTG4nl5fcEAa6B1st0OxjVWiSLX3g/yjz8lznQb9awuRjdeHMnyx5DsJUN | ||
d+Iu5KxGupQvKGOMKivSvC8VWk9taaQRpRF+++6stLCDk3ZtlxiopMs3X2jAp6xG | ||
sOBbix1cv9BTsfaiL7XDL/gviqBPXYY5L42x6+jnPo5lROfnlLYkWrv6KZr7HD4k | ||
tRXeaSwxLD2EkUyb16Jpp0be/ofvBtITGUDDLCGBiaXtx/v8d52MARjsyLJSYloj | ||
1yiW01LfAiWHUC4z5jl2T7E7sicrlLH1M8Z6WbuqjdeaYwtfyPA2YCKr/3fn6pIo | ||
D+pYaBSESmhA92P+XVaf5y2BZ6Qf8LveDpWwsVGdBGh9T0raA1ooe1GESLjmIjUa | ||
z5AeQ/uXL5Md9I6bpMUUJYQiH19RPcFlJriI3phXyyf6Wlkk8oVEeCWyzcmw+x1V | ||
deRTvE2x4WIwKGLXRNjin2j1AP7vU2HaNwlPrLijqdyi68+0irRQONoH7Qonr4ca | ||
xWgL+pAaa3dWxf0xqK7uZFp4aTVWlr2uXtV/eaUtLmGMCU0jnjb109wg5L0F7WRT | ||
PfEAEQEAAYkCNgQYAQoAIBYhBF/tstDqLEkG3WZx16LFC0DOPPKXBQJhAZleAhsM | ||
AAoJEKLFC0DOPPKXAAEP/jK7ch9GkoaYlsuqY/aHtxEwVddUDOxjyn3FMDoln85L | ||
/n8AmLQb2bcpKSqpaJwMbmfEyr5MDm8xnsBTfx3u6kgaLOWfKxjLQ6PM7kgIMdi4 | ||
bfaRRuSEI1/R6c/hNpiGnzAeeexldH1we+eH1IVmh4crdat49S2xh7Qlv9ahvgsP | ||
LfKl3rJ+aaX/Ok0AHzhvSfhFpPr1gAaGeaRt+rhlZsx2QyG4Ez8p2nDAcAzPiB3T | ||
73ENoBIX6mTPfPm1UgrRyFKBqtUzAodz66j3r6ebBlWzIRg8iZenVMAxzjINAsxN | ||
w1Bzfgsi5ZespfsSlmEaa7jJkqqDuEcLa2YuiFAue7Euqwz1aGeq1GfTicQioSCb | ||
Ur/LGyz2Mj3ykbaP8p5mFVcUN51yQy6OcpvR/W1DfRT9SHFT/bCf9ixsjB2HlZGo | ||
uxPJowwqmMgHd755ZzPDUM9YDgLI1yXdcYshObv3Wq537JAxnZJCGRK4Y8SwrMSh | ||
8WRxlaM0AGWXiJFIDD4bQPIdnF3X8w0cGWE5Otkb8mMHOT+rFTVlDODwm1zF6oIG | ||
PTwfVrpiZBwiUtfJol1exr/MzSPyGoJnYs3cRf2E3O+D1LbcR8w0LbjGuUy38Piz | ||
ZO/vCeyJ3JZC5kE8nD+XBA4idwzh0BKEfH9t+WchQ3Up9rxyzLyQamoqt5Xby4pY | ||
=xkM3 | ||
-----END PGP PUBLIC KEY BLOCK----- | ||
``` |