-
Notifications
You must be signed in to change notification settings - Fork 96
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
21c2066
commit 97d92cb
Showing
8 changed files
with
169 additions
and
281 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules β¦
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,10 @@ | ||
# This CODEOWNERS file sets the individuals responsible for code in the era-test-node repository. | ||
|
||
# These users are the default owners for everything in the repo. | ||
# They will be requested for review when someone opens a pull request. | ||
* @JackHamer09 | ||
|
||
# You can also specify code owners for specific directories or files. | ||
# For example: | ||
# /src/ @developer1 @developer2 | ||
# /docs/ @documenter |
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,70 @@ | ||
# Contributing to zkSync Era CLI | ||
|
||
## Welcome! π | ||
|
||
Hello, contributor! Thanks for thinking about helping with the `zkSync Era CLI` project. This guide will help you understand how to contribute to our CLI tool. | ||
|
||
## Getting Started | ||
|
||
- **Fork the project.** First, fork the `zkSync Era CLI` repository to your GitHub account. | ||
|
||
- **Download the project.** Now, get the project on your computer: | ||
|
||
```bash | ||
git clone https://github.com/<your-github-username>/zksync-cli.git | ||
``` | ||
|
||
- **Make a new branch.** Give your branch a simple name that tells what you're working on: | ||
|
||
```bash | ||
git checkout -b my-new-feature | ||
``` | ||
|
||
## Making Changes | ||
|
||
- **Write your code.** Keep your code clear and easy to understand. It helps everyone. | ||
|
||
- **Build and check your code.** Before you ask others to look at your code, make sure it works well. You can use these commands: | ||
|
||
```bash | ||
npm run build | ||
node ./bin [your-command] | ||
``` | ||
|
||
- **Save your changes.** Use easy-to-understand messages when saving your changes. | ||
|
||
- **Send your changes.** Now, put your code back on your GitHub: | ||
|
||
```bash | ||
git push origin my-new-feature | ||
``` | ||
|
||
## Sending a Pull Request | ||
|
||
- **Ask to add your changes.** Go to the `zkSync Era CLI` project on GitHub. You'll see a button "Compare & pull request." Click it and tell us about your changes. | ||
|
||
- **Wait for feedback.** Our team will look at your changes. We might ask you to change some things. | ||
|
||
Remember, we have a system that checks your code automatically when you ask to add your changes. Make sure you pass that check! | ||
|
||
## Code Style | ||
|
||
We have rules about how to write code. This helps everyone understand and trust the code. Use this command to make sure your code follows our rules: | ||
|
||
```bash | ||
npm run lint | ||
``` | ||
|
||
## Questions? | ||
|
||
If you have questions, you can ask on our [zkSync Community Hub](https://github.com/zkSync-Community-Hub/zkSync-developers/discussions). We're here to help! | ||
|
||
## Thank You! | ||
|
||
After we add your changes to the `zkSync Era CLI` project, we'll be very thankful! Your help makes our project better. | ||
|
||
We hope you enjoy helping and come back to help more. Thanks for being part of our team! | ||
|
||
--- | ||
|
||
*Last update: September 1, 2023* |
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,45 @@ | ||
--- | ||
name: Bug report | ||
about: Use this template for reporting issues | ||
title: "" | ||
labels: bug | ||
assignees: '' | ||
|
||
--- | ||
|
||
### π Bug Report for zkSync CLI | ||
#### π Description | ||
|
||
Provide a clear and concise description of the bug. | ||
|
||
#### π Reproduction Steps | ||
|
||
1. Step 1 | ||
2. Step 2 | ||
3. ... | ||
|
||
#### π€ Expected Behavior | ||
|
||
Describe what you expected to happen. | ||
|
||
#### π― Current Behavior | ||
|
||
Describe what actually happened. | ||
|
||
#### π₯οΈ Environment | ||
|
||
- **Package version**: [e.g., 1.2.1] | ||
- **Node version**: [e.g., node v16.14.0] | ||
- **NPM/Yarn version**: [e.g., npm 8.3.1] | ||
- **Operating System & Version**: [e.g., Ubuntu 20.04] | ||
- **Other relevant environment details**: | ||
|
||
#### π Additional Context | ||
|
||
Add any other context about the problem here. If applicable, add screenshots to help explain. | ||
|
||
#### π Log Output | ||
|
||
``` | ||
Paste any relevant log output here. | ||
``` |
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,8 @@ | ||
blank_issues_enabled: true | ||
contact_links: | ||
- name: zksync-developers Discussion | ||
url: https://github.com/zkSync-Community-Hub/zkync-developers/discussions | ||
about: Please provide feedback, and ask questions here. | ||
- name: zksync-cli documentation page | ||
url: https://era.zksync.io/docs/tools/zksync-cli | ||
about: Please refer to the documentation for immediate answers. |
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,17 @@ | ||
# What :computer: | ||
* First thing updated with this PR | ||
* Second thing updated with this PR | ||
* Third thing updated with this PR | ||
|
||
# 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 | ||
|
||
# Evidence :camera: | ||
Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended | ||
|
||
<!-- All sections below are optional. You can erase any section not applicable to your Pull Request. --> | ||
|
||
# Notes :memo: | ||
* Any notes/thoughts that the reviewers should know prior to reviewing the code? |
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
Oops, something went wrong.