-
Notifications
You must be signed in to change notification settings - Fork 223
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
Showing
449 changed files
with
85,734 additions
and
29,093 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,45 +1,35 @@ | ||
# Contributing | ||
|
||
Thank you for considering to help out with the source code! We welcome | ||
contributions from anyone on the internet, and are grateful for even the | ||
Thank you for considering to help out with the source code! We welcome | ||
contributions from anyone on the internet, and are grateful for even the | ||
smallest of fixes! | ||
|
||
If you'd like to contribute to subnet-evm, please fork, fix, commit and send a | ||
If you'd like to contribute to coreth, please fork, fix, commit and send a | ||
pull request for the maintainers to review and merge into the main code base. If | ||
you wish to submit more complex changes though, please check up with the core | ||
devs first on [Discord](https://chat.avalabs.org) to | ||
ensure those changes are in line with the general philosophy of the project | ||
you wish to submit more complex changes though, please check up with the core | ||
devs first on [Discord](https://chat.avalabs.org) to | ||
ensure those changes are in line with the general philosophy of the project | ||
and/or get some early feedback which can make both your efforts much lighter as | ||
well as our review and merge procedures quick and simple. | ||
|
||
## Coding guidelines | ||
|
||
Please make sure your contributions adhere to our coding and documentation | ||
guidelines: | ||
|
||
- Code must adhere to the official Go | ||
[formatting](https://go.dev/doc/effective_go#formatting) guidelines | ||
(i.e. uses [gofmt](https://pkg.go.dev/cmd/gofmt)). | ||
- Pull requests need to be based on and opened against the `master` branch. | ||
- Pull reuqests should include a detailed description | ||
- Commits are required to be signed. See [here](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) | ||
for information on signing commits. | ||
- Commit messages should be prefixed with the package(s) they modify. | ||
- E.g. "eth, rpc: make trace configs optional" | ||
|
||
## Documentation guidelines | ||
|
||
- Code should be well commented, so it is easier to read and maintain. | ||
Any complex sections or invariants should be documented explicitly. | ||
- Code must be documented adhering to the official Go | ||
[commentary](https://go.dev/doc/effective_go#commentary) guidelines. | ||
- Changes with user facing impact (e.g., addition or modification of flags and | ||
options) should be accompanied by a link to a pull request to the [avalanche-docs](https://github.com/ava-labs/avalanche-docs) | ||
repository. [example](https://github.com/ava-labs/avalanche-docs/pull/1119/files). | ||
- Changes that modify a package significantly or add new features should | ||
either update the existing or include a new `README.md` file in that package. | ||
Please make sure your contributions adhere to our coding guidelines: | ||
|
||
* Code must adhere to the official Go | ||
[formatting](https://go.dev/doc/effective_go#formatting) guidelines | ||
(i.e. uses [gofmt](https://pkg.go.dev/cmd/gofmt)). | ||
* Code must be documented adhering to the official Go | ||
[commentary](https://go.dev/doc/effective_go#commentary) guidelines. | ||
* Pull requests need to be based on and opened against the `master` branch. | ||
* Pull reuqests should include a detailed description | ||
* Commits are required to be signed. See [here](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) | ||
for information on signing commits. | ||
* Commit messages should be prefixed with the package(s) they modify. | ||
* E.g. "eth, rpc: make trace configs optional" | ||
|
||
## Can I have feature X | ||
|
||
Before you submit a feature request, please check and make sure that it isn't | ||
Before you submit a feature request, please check and make sure that it isn't | ||
possible through some other means. | ||
|
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,20 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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 |
---|---|---|
|
@@ -3,5 +3,3 @@ | |
## How this works | ||
|
||
## How this was tested | ||
|
||
## How is this documented |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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,125 @@ | ||
name: CI | ||
on: | ||
push: | ||
branches: | ||
- master | ||
pull_request: | ||
workflow_dispatch: | ||
inputs: | ||
avalanchegoRepo: | ||
description: "avalanchego github repository" | ||
required: true | ||
default: "ava-labs/avalanchego" | ||
avalanchegoBranch: | ||
description: "avalanchego branch" | ||
required: true | ||
default: "master" | ||
|
||
jobs: | ||
lint: | ||
name: Lint | ||
runs-on: ubuntu-20.04 | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: check out ${{ github.event.inputs.avalanchegoRepo }} ${{ github.event.inputs.avalanchegoBranch }} | ||
if: ${{ github.event_name == 'workflow_dispatch' }} | ||
uses: actions/checkout@v4 | ||
with: | ||
repository: ${{ github.event.inputs.avalanchegoRepo }} | ||
ref: ${{ github.event.inputs.avalanchegoBranch }} | ||
path: avalanchego | ||
token: ${{ secrets.AVALANCHE_PAT }} | ||
- uses: actions/setup-go@v5 | ||
with: | ||
go-version: "~1.21.12" | ||
check-latest: true | ||
- name: change avalanchego dep | ||
if: ${{ github.event_name == 'workflow_dispatch' }} | ||
run: | | ||
go mod edit -replace github.com/ava-labs/avalanchego=./avalanchego | ||
go mod tidy | ||
go clean -modcache # avoid conflicts with the golangci-lint-action cache | ||
- run: ./scripts/lint_allowed_geth_imports.sh | ||
shell: bash | ||
- name: golangci-lint | ||
uses: golangci/golangci-lint-action@v3 | ||
with: | ||
version: v1.56 | ||
working-directory: . | ||
args: --timeout 3m | ||
skip-pkg-cache: true | ||
- name: Run shellcheck | ||
shell: bash | ||
run: scripts/shellcheck.sh | ||
- name: Run actionlint | ||
shell: bash | ||
run: scripts/actionlint.sh | ||
test: | ||
name: Golang Unit Tests (${{ matrix.os }}) | ||
runs-on: ${{ matrix.os }} | ||
strategy: | ||
fail-fast: false | ||
matrix: | ||
os: [macos-latest, ubuntu-20.04, ubuntu-latest, windows-latest] | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: check out ${{ github.event.inputs.avalanchegoRepo }} ${{ github.event.inputs.avalanchegoBranch }} | ||
if: ${{ github.event_name == 'workflow_dispatch' }} | ||
uses: actions/checkout@v4 | ||
with: | ||
repository: ${{ github.event.inputs.avalanchegoRepo }} | ||
ref: ${{ github.event.inputs.avalanchegoBranch }} | ||
path: avalanchego | ||
token: ${{ secrets.AVALANCHE_PAT }} | ||
- uses: actions/setup-go@v5 | ||
with: | ||
go-version: "~1.21.12" | ||
check-latest: true | ||
- name: change avalanchego dep | ||
if: ${{ github.event_name == 'workflow_dispatch' }} | ||
run: | | ||
go mod edit -replace github.com/ava-labs/avalanchego=./avalanchego | ||
go mod tidy | ||
- name: Set timeout on Windows # Windows UT run slower and need a longer timeout | ||
shell: bash | ||
if: matrix.os == 'windows-latest' | ||
run: echo "TIMEOUT=1200s" >> "$GITHUB_ENV" | ||
- run: go mod download | ||
shell: bash | ||
- run: ./scripts/build.sh evm | ||
shell: bash | ||
- run: ./scripts/build_test.sh | ||
shell: bash | ||
env: | ||
TIMEOUT: ${{ env.TIMEOUT }} | ||
- run: ./scripts/coverage.sh | ||
shell: bash | ||
avalanchego_e2e: | ||
name: AvalancheGo E2E Tests (${{ matrix.os }}) | ||
runs-on: ${{ matrix.os }} | ||
strategy: | ||
matrix: | ||
os: [ubuntu-20.04] | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: check out ${{ github.event.inputs.avalanchegoRepo }} ${{ github.event.inputs.avalanchegoBranch }} | ||
if: ${{ github.event_name == 'workflow_dispatch' }} | ||
uses: actions/checkout@v4 | ||
with: | ||
repository: ${{ github.event.inputs.avalanchegoRepo }} | ||
ref: ${{ github.event.inputs.avalanchegoBranch }} | ||
path: avalanchego | ||
token: ${{ secrets.AVALANCHE_PAT }} | ||
- uses: actions/setup-go@v5 | ||
with: | ||
go-version: "~1.21.12" | ||
check-latest: true | ||
- name: Run e2e tests | ||
run: E2E_SERIAL=1 ./scripts/tests.e2e.sh | ||
shell: bash | ||
- name: Upload tmpnet network dir | ||
uses: actions/upload-artifact@v4 | ||
if: always() | ||
with: | ||
name: tmpnet-data | ||
path: ~/.tmpnet/networks/1000 |
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 was deleted.
Oops, something went wrong.
Oops, something went wrong.