Skip to content

Commit 22b62b4

Browse files
yorikyorik
authored
chore: Syncs common workflows from the template into main (#4)
1 parent 7b6ba3b commit 22b62b4

File tree

7 files changed

+212
-6
lines changed

7 files changed

+212
-6
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Bug report
3+
about: Use this template for reporting issues
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
### 🐛 Bug Report
10+
11+
#### 📝 Description
12+
13+
Provide a clear and concise description of the bug.
14+
15+
#### 🔄 Reproduction Steps
16+
17+
Steps to reproduce the behaviour
18+
19+
#### 🤔 Expected Behavior
20+
21+
Describe what you expected to happen.
22+
23+
#### 😯 Current Behavior
24+
25+
Describe what actually happened.
26+
27+
#### 🖥️ Environment
28+
29+
Any relevant environment details.
30+
31+
#### 📋 Additional Context
32+
33+
Add any other context about the problem here. If applicable, add screenshots to help explain.
34+
35+
#### 📎 Log Output
36+
37+
```
38+
Paste any relevant log output here.
39+
```

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: Feature request
3+
about: Use this template for requesting features
4+
title: ''
5+
labels: feat
6+
assignees: ''
7+
---
8+
9+
### 🌟 Feature Request
10+
11+
#### 📝 Description
12+
13+
Provide a clear and concise description of the feature you'd like to see.
14+
15+
#### 🤔 Rationale
16+
17+
Explain why this feature is important and how it benefits the project.
18+
19+
#### 📋 Additional Context
20+
21+
Add any other context or information about the feature request here.

‎.github/pull_request_template.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# What ❔
2+
3+
<!-- What are the changes this PR brings about? -->
4+
<!-- Example: This PR adds a PR template to the repo. -->
5+
<!-- (For bigger PRs adding more context is appreciated) -->
6+
7+
## Why ❔
8+
9+
<!-- Why are these changes done? What goal do they contribute to? What are the principles behind them? -->
10+
<!-- Example: PR templates ensure PR reviewers, observers, and future iterators are in context about the evolution of repos. -->
11+
12+
## Checklist
13+
14+
<!-- Check your PR fulfills the following items. -->
15+
<!-- For draft PRs check the boxes as you complete them. -->
16+
17+
- [ ] PR title corresponds to the body of PR (we generate changelog entries from PRs).
18+
- [ ] Tests for the changes have been added / updated.
19+
- [ ] Documentation comments have been added / updated.
20+
- [ ] Code has been formatted via `zk fmt` and `zk lint`.

‎.github/workflows/secrets_scanner.yaml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Leaked Secrets Scan
2+
on: [pull_request]
3+
jobs:
4+
TruffleHog:
5+
runs-on: ubuntu-latest
6+
steps:
7+
- name: Checkout code
8+
uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3
9+
with:
10+
fetch-depth: 0
11+
- name: TruffleHog OSS
12+
uses: trufflesecurity/trufflehog@0c66d30c1f4075cee1aada2e1ab46dabb1b0071a
13+
with:
14+
path: ./
15+
base: ${{ github.event.repository.default_branch }}
16+
head: HEAD
17+
extra_args: --debug --only-verified

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@ cmake-build-*
66
ignore
77
out
88
profile
9-
.github
9+
1010

‎CONTRIBUTING.md‎

Lines changed: 40 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,44 @@
11
# Contribution Guidelines
22

3-
Thank you for considering helping out with the source code! We are extremely grateful for any consideration of
4-
contributions to this repository. However, at this time, we generally do not accept external contributions. This policy
5-
will change in the future, so please check back regularly for updates.
3+
Hello! Thanks for your interest in joining the mission to accelerate the mass adoption of crypto for personal
4+
sovereignty! We welcome contributions from anyone on the internet, and are grateful for even the smallest of fixes!
65

7-
For security issues, please contact us at [security@matterlabs.dev](mailto:security@matterlabs.dev).
6+
## Ways to contribute
87

9-
Thank you for your support in accelerating the mass adoption of crypto for personal sovereignty!
8+
There are many ways to contribute to the ZK Stack:
9+
10+
1. Open issues: if you find a bug, have something you believe needs to be fixed, or have an idea for a feature, please
11+
open an issue.
12+
2. Add color to existing issues: provide screenshots, code snippets, and whatever you think would be helpful to resolve
13+
issues.
14+
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
15+
and opening a PR.
16+
4. Report security issues, see [our security policy](./github/SECURITY.md).
17+
5. [Join the team!](https://matterlabs.notion.site/Shape-the-future-of-Ethereum-at-Matter-Labs-dfb3b5a037044bb3a8006af2eb0575e0)
18+
19+
## Fixing issues
20+
21+
To contribute code fixing issues, please fork the repo, fix an issue, commit, add documentation as per the PR template,
22+
and the repo's maintainers will review the PR.
23+
[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)
24+
for guidance how to work with PRs created from a fork.
25+
26+
## Licenses
27+
28+
If you contribute to this project, your contributions will be made to the project under both Apache 2.0 and the MIT
29+
license.
30+
31+
## Resources
32+
33+
We aim to make it as easy as possible to contribute to the mission. This is still WIP, and we're happy for contributions
34+
and suggestions here too. Some resources to help:
35+
36+
1. [In-repo docs aimed at developers](docs)
37+
2. [zkSync Era docs!](https://era.zksync.io/docs/)
38+
3. Company links can be found in the [repo's readme](README.md)
39+
40+
## Code of Conduct
41+
42+
Be polite and respectful.
43+
44+
### Thank you

‎SECURITY.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Security Policy
2+
3+
We truly appreciate efforts to discover and disclose security issues responsibly!
4+
5+
## Vulnerabilities
6+
7+
If you'd like to report a security issue in the repositories of matter-labs organization, please proceed to our
8+
[Bug Bounty Program on Immunefi](https://era.zksync.io/docs/reference/troubleshooting/audit-bug-bounty.html#bug-bounty-program).
9+
10+
## Other Security Issues
11+
12+
We take an impact-first approach instead of a rules-first approach. Therefore, if you believe you found the impactful
13+
issue but can't report it via the Bug Bounty, please email us at
14+
[security@matterlabs.dev](mailto:security@matterlabs.dev).
15+
16+
### PGP Key
17+
18+
The following PGP key may be used to communicate sensitive information to developers:
19+
20+
Fingerprint: `5FED B2D0 EA2C 4906 DD66 71D7 A2C5 0B40 CE3C F297`
21+
22+
```
23+
-----BEGIN PGP PUBLIC KEY BLOCK-----
24+
25+
mQINBGEBmQkBEAD6tlkBEZFMvR8kOgxXX857nC2+oTik6TopJz4uCskuqDaeldMy
26+
l+26BBzLkIeO1loS+bzVgnNFJRrGt9gv98MzNEHJVv6D7GsSLlUX/pz7Lxn0J4ry
27+
o5XIk3MQTCUBdaXGs6GBLl5Xe8o+zNj4MKd4zjgDLinITNlE/YZCDsXyvYS3YFTQ
28+
cwaUTNlawkKgw4BLaEqwB2JuyEhI9wx5X7ibjFL32sWMolYsNAlzFQzM09HCurTn
29+
q0DYau9kPJARcEk9/DK2iq0z3gMCQ8iRTDaOWd8IbSP3HxcEoM5j5ZVAlULmjmUE
30+
StDaMPLj0Kh01Tesh/j+vjchPXHT0n4zqi1+KOesAOk7SIwLadHfQMTpkU7G2fR1
31+
BrA5MtlzY+4Rm6o7qu3dpZ+Nc4iM3FUnaQRpvn4g5nTh8vjG94OCzX8DXWrCKyxx
32+
amCs9PLDYOpx84fXYv4frkWpKh2digDSUGKhoHaOSnqyyvu3BNWXBCQZJ20rqEIu
33+
sXOQMxWIoWCOOPRRvrHrKDA2hpoKjs3pGsProfpVRzb9702jhWpTfbDp9WjQlFtX
34+
2ZIDxlwAxcugClgrp5JiUxvhg2A9lDNwCF7r1e68uNv5usBZQVKPJmnvS2nWgKy8
35+
x9oJsnwrEjxwiRHd34UvfMkwY9RENSJ+NoXqBdS7Lwz4m6vgbzq6K56WPQARAQAB
36+
tCRaa1N5bmMgU2VjdXJpdHkgPHNlY3VyaXR5QHprc3luYy5pbz6JAk4EEwEKADgW
37+
IQRf7bLQ6ixJBt1mcdeixQtAzjzylwUCYQGZCQIbAwULCQgHAgYVCgkICwIEFgID
38+
AQIeAQIXgAAKCRCixQtAzjzyl5y8EAC/T3oq88Dak2b+5TlWdU2Gpm6924eAqlMt
39+
y1KksDezzNQUlPiCUVllpin2PIjU/S+yzMWKXJA04LoVkEPfPOWjAaavLOjRumxu
40+
MR6P2dVUg1InqzYVsJuRhKSpeexzNA5qO2BPM7/I2Iea1IoJPjogGbfXCo0r5kne
41+
KU7a5GEa9eDHxpHTsbphQe2vpQ1239mUJrFpzAvILn6jV1tawMn5pNCXbsa8l6l2
42+
gtlyQPdOQECy77ZJxrgzaUBcs/RPzUGhwA/qNuvpF0whaCvZuUFMVuCTEu5LZka2
43+
I9Rixy+3jqBeONBgb+Fiz5phbiMX33M9JQwGONFaxdvpFTerLwPK2N1T8zcufa01
44+
ypzkWGheScFZemBxUwXwK4x579wjsnfrY11w0p1jtDgPTnLlXUA2mom4+7MyXPg0
45+
F75qh6vU1pdXaCVkruFgPVtIw+ccw2AxD50iZQ943ZERom9k165dR9+QxOVMXQ4P
46+
VUxsFZWvK70/s8TLjsGljvSdSOa85iEUqSqh0AlCwIAxLMiDwh5s/ZgiHoIM6Xih
47+
oCpuZyK9p0dn+DF/XkgAZ/S91PesMye3cGm6M5r0tS26aoc2Pk6X37Hha1pRALwo
48+
MOHyaGjc/jjcXXxv6o55ALrOrzS0LQmLZ+EHuteCT15kmeY3kqYJ3og62KgiDvew
49+
dKHENvg7d7kCDQRhAZleARAA6uD6WfdqGeKV5i170+kLsxR3QGav0qGNAbxpSJyn
50+
iHQ8u7mQk3S+ziwN2AAopfBk1je+vCWtEGC3+DWRRfJSjLbtaBG8e6kLP3/cGA75
51+
qURz6glTG4nl5fcEAa6B1st0OxjVWiSLX3g/yjz8lznQb9awuRjdeHMnyx5DsJUN
52+
d+Iu5KxGupQvKGOMKivSvC8VWk9taaQRpRF+++6stLCDk3ZtlxiopMs3X2jAp6xG
53+
sOBbix1cv9BTsfaiL7XDL/gviqBPXYY5L42x6+jnPo5lROfnlLYkWrv6KZr7HD4k
54+
tRXeaSwxLD2EkUyb16Jpp0be/ofvBtITGUDDLCGBiaXtx/v8d52MARjsyLJSYloj
55+
1yiW01LfAiWHUC4z5jl2T7E7sicrlLH1M8Z6WbuqjdeaYwtfyPA2YCKr/3fn6pIo
56+
D+pYaBSESmhA92P+XVaf5y2BZ6Qf8LveDpWwsVGdBGh9T0raA1ooe1GESLjmIjUa
57+
z5AeQ/uXL5Md9I6bpMUUJYQiH19RPcFlJriI3phXyyf6Wlkk8oVEeCWyzcmw+x1V
58+
deRTvE2x4WIwKGLXRNjin2j1AP7vU2HaNwlPrLijqdyi68+0irRQONoH7Qonr4ca
59+
xWgL+pAaa3dWxf0xqK7uZFp4aTVWlr2uXtV/eaUtLmGMCU0jnjb109wg5L0F7WRT
60+
PfEAEQEAAYkCNgQYAQoAIBYhBF/tstDqLEkG3WZx16LFC0DOPPKXBQJhAZleAhsM
61+
AAoJEKLFC0DOPPKXAAEP/jK7ch9GkoaYlsuqY/aHtxEwVddUDOxjyn3FMDoln85L
62+
/n8AmLQb2bcpKSqpaJwMbmfEyr5MDm8xnsBTfx3u6kgaLOWfKxjLQ6PM7kgIMdi4
63+
bfaRRuSEI1/R6c/hNpiGnzAeeexldH1we+eH1IVmh4crdat49S2xh7Qlv9ahvgsP
64+
LfKl3rJ+aaX/Ok0AHzhvSfhFpPr1gAaGeaRt+rhlZsx2QyG4Ez8p2nDAcAzPiB3T
65+
73ENoBIX6mTPfPm1UgrRyFKBqtUzAodz66j3r6ebBlWzIRg8iZenVMAxzjINAsxN
66+
w1Bzfgsi5ZespfsSlmEaa7jJkqqDuEcLa2YuiFAue7Euqwz1aGeq1GfTicQioSCb
67+
Ur/LGyz2Mj3ykbaP8p5mFVcUN51yQy6OcpvR/W1DfRT9SHFT/bCf9ixsjB2HlZGo
68+
uxPJowwqmMgHd755ZzPDUM9YDgLI1yXdcYshObv3Wq537JAxnZJCGRK4Y8SwrMSh
69+
8WRxlaM0AGWXiJFIDD4bQPIdnF3X8w0cGWE5Otkb8mMHOT+rFTVlDODwm1zF6oIG
70+
PTwfVrpiZBwiUtfJol1exr/MzSPyGoJnYs3cRf2E3O+D1LbcR8w0LbjGuUy38Piz
71+
ZO/vCeyJ3JZC5kE8nD+XBA4idwzh0BKEfH9t+WchQ3Up9rxyzLyQamoqt5Xby4pY
72+
=xkM3
73+
-----END PGP PUBLIC KEY BLOCK-----
74+
```

0 commit comments

Comments
 (0)