Skip to content

Commit

Permalink
chore: make repo open-source ready
Browse files Browse the repository at this point in the history
  • Loading branch information
JackHamer09 committed Sep 1, 2023
1 parent 21c2066 commit 97d92cb
Show file tree
Hide file tree
Showing 8 changed files with 169 additions and 281 deletions.
10 changes: 10 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
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
70 changes: 70 additions & 0 deletions .github/CONTRIBUTING.md
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*
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
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.
```
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
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.
17 changes: 17 additions & 0 deletions .github/pull_request_template.md
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?
24 changes: 9 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,20 @@

This CLI tool simplifies the process of developing applications and interacting with zkSync Era.

[Report a bug](https://github.com/matter-labs/zksync-cli/issues/new) | [Request a feature](https://github.com/matter-labs/zksync-cli/issues/new)
[Documentation](https://era.zksync.io/docs/tools/zksync-cli) | [Report a bug](https://github.com/matter-labs/zksync-cli/issues/new) | [Request a feature](https://github.com/matter-labs/zksync-cli/issues/new)

[pr-welcome]: https://img.shields.io/static/v1?color=indigo&label=PRs&style=flat&message=welcome

</div>

## πŸ›  Prerequisites

- Node.js v18.x / NPM
- Yarn
- Node.js v18.x
- NPM / Yarn

## πŸ“₯ Installation

You can install this program globally with `npm i -g zksync-cli` or run the commands direcly via NPX with `npx zksync-cli@latest {COMMAND}`.
You can install this program globally with `npm i -g zksync-cli` or run the commands directly via NPX with `npx zksync-cli@latest {COMMAND}`.

## πŸ’» Commands

Expand All @@ -40,34 +40,28 @@ You can install this program globally with `npm i -g zksync-cli` or run the comm

### βš™οΈ Options (flags)

- `--zeek`: zeek, the dev cat, will search for an inspirational quote and provide to you at the end of any command.
- `--l1-rpc-url`: override the default L1 rpc URL when `localnet` is selected as the network. Usage `--l1-rpc-url=http://...`.
- `--l2-rpc-url`: override the default L2 rpc URL when `localnet` is selected as the network. Usage `--l1-rpc-url=http://...`.
- `--zeek`: zeek, the dev cat, will search for an inspirational quote and provide to you at the end of any command.

## πŸ‘©β€πŸ’» Developing new features

### Install and build

1. Install all dendencies with `npm i`.
1. Install all dependencies with `npm i`.
2. This project was build with Typescript. Run `npm run build` to compile code in `/src` into `/bin`.

To create a version run:

```sh
git tag v0.1.3 // with the correspondent tag
git push --tags
```
3. You can run your local build with `node ./bin`

### Testing

> ⚠️ This project does not have unit tests yet πŸ€•
Proper tests will be included soon. For now, you can test new changes locally by installing this package globably with `npm i -g`.
Proper tests will be included soon. For now, you can test new changes manually by running your build (refer to [Install and build](#install-and-build)).


### πŸ“Š Tracking

zkSync-cli tracks its usage for the single purpose of providing data so it can be improved. Data is fully anonymized. If you want to disable the tracking, set the environment variable NO_TRACKING to `true`.
zkSync-cli tracks its usage for the single purpose of providing data so it can be improved. Data is fully anonymized. If you want to disable the tracking, set the environment variable `NO_TRACKING` to `true`.

## 🌍 Official Links

Expand Down
Loading

0 comments on commit 97d92cb

Please sign in to comment.