-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: setup the project according to OS guideline
- Loading branch information
1 parent
760bf14
commit 593ee1f
Showing
9 changed files
with
259 additions
and
397 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 zksync2-go Golang SDK repository. | ||
|
||
# These users are the default owners for everything in the repo. | ||
# They will be requested for review when someone opens a pull request. | ||
* @zksync-sdk/txfusion | ||
|
||
# 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,71 @@ | ||
# Contributing | ||
|
||
## Welcome! 👋 | ||
|
||
Hello there, contributor! We're delighted that you're considering contributing to the `zksync2-go` project. This document is here to guide you through the steps and best practices for contributing to this Golang-based repository. | ||
|
||
Please take a moment to review this document to ensure a smooth and efficient contribution process for everyone involved. | ||
|
||
## Getting Started | ||
|
||
- **Fork the repository.** Begin by forking the main `zksync2-go` repository to your personal GitHub account. | ||
|
||
- **Clone the repository.** After forking, clone the repository to your local machine: | ||
|
||
```bash | ||
git clone https://github.com/<your-github-username>/zksync2-go.git | ||
``` | ||
|
||
- **Create a new branch.** Use descriptive names for your branches to help identify the feature, bugfix, or enhancement you're addressing: | ||
|
||
```bash | ||
git checkout -b feature/description-of-your-feature | ||
``` | ||
|
||
## Making Changes | ||
|
||
- **Write your code.** Ensure your code is thoroughly tested and functions as expected. Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. | ||
- **Compile and test.** Before submitting a pull request, ensure your code compiles, passes lint checks, and all tests are successful. You should also write unit tests for your contributions. Use the following command for these checks: | ||
|
||
```bash | ||
go fmt ./... | ||
got test ./... | ||
``` | ||
|
||
- **Commit your changes.** Adhere to the [Conventional Commits](https://www.conventionalcommits.org/) standard when writing commit messages. | ||
|
||
- **Push your changes.** Push the changes to your forked repository: | ||
|
||
```bash | ||
git push origin feature/description-of-your-feature | ||
``` | ||
|
||
## Submitting a Pull Request | ||
|
||
- **Initiate a pull request (PR).** Go to the main `zksync2-go` repository. Your recently pushed branch should be highlighted, showing a "Compare & pull request" button. Click on it and provide a clear, detailed description of your changes in the PR. | ||
|
||
- **Await a review.** Our maintainers will review your PR. They might request changes or clarifications, so be ready to address any feedback. | ||
|
||
## Code Style Guide | ||
|
||
We follow basic coding style guidelines. Before committing, ensure your code is formatted and lint checks pass: | ||
|
||
```bash | ||
go fmt ./... | ||
``` | ||
|
||
This ensures consistent code style throughout the project and helps identify potential issues early. | ||
|
||
## Need Assistance? | ||
|
||
If you're unsure about something or have questions, don't hesitate to open an issue or initiate a discussion in our [zkSync Community Hub](https://github.com/zkSync-Community-Hub/zkSync-developers/discussions). We're here to assist! | ||
|
||
## What's Next? | ||
|
||
Once your PR is approved and merged, your contribution will be integrated into the `zksync2-go` repository. Congratulations, and thank you! We value your contribution and look forward to future collaborations. | ||
|
||
Remember, the best contributions come from enjoying the process, being respectful, and continuously learning. Thanks for being a part of our community! | ||
|
||
--- | ||
|
||
*Last updated: Nov 10, 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 zksync2-js JavaScript SDK | ||
|
||
#### 📝 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 | ||
|
||
- **Node version**: [e.g., Node 18.16.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,11 @@ | ||
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-web3 SDK documentation page | ||
url: https://era.zksync.io/docs/api/js/ | ||
about: Please refer to the documentation for immediate answers. | ||
- name: zksync2-js SDK documentation page | ||
url: https://era.zksync.io/docs/api/js/zksync2-js | ||
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,26 @@ | ||
--- | ||
name: Feature request | ||
about: Use this template for requesting features | ||
title: "" | ||
labels: feat | ||
assignees: '' | ||
|
||
--- | ||
|
||
### 🌟 Feature Request | ||
|
||
#### 📝 Description | ||
|
||
Provide a clear and concise description of the feature you'd like to see. | ||
|
||
#### 🤔 Rationale | ||
|
||
Explain why this feature is important and how it benefits the project. | ||
|
||
#### 🖼️ Mockups/Examples | ||
|
||
If applicable, provide mockups or examples of how the feature would work. | ||
|
||
#### 📋 Additional Context | ||
|
||
Add any other context or information about the feature request 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,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 was deleted.
Oops, something went wrong.
Oops, something went wrong.