-
Notifications
You must be signed in to change notification settings - Fork 222
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Precompile improvements merge (#513)
Co-authored-by: aaronbuchwald <aaron.buchwald56@gmail.com> Co-authored-by: Ceyhun Onur <ceyhun.onur@avalabs.org> Co-authored-by: Darioush Jalali <darioush.jalali@avalabs.org> Co-authored-by: cam-schultz <78878559+cam-schultz@users.noreply.github.com> Co-authored-by: Matthew Lam <matthew.lam@avalabs.org> Co-authored-by: cam-schultz <camschultz32@gmail.com> Co-authored-by: omahs <73983677+omahs@users.noreply.github.com> Co-authored-by: Anusha <63559942+anusha-ctrl@users.noreply.github.com> Co-authored-by: Hagen Hübel <hhuebel@itinance.com> Co-authored-by: minghinmatthewlam <matthew.lam@avalabs.org> Fix: typos (#428) fix allow list comments (#469) fix CGO flags issue (#489) fix lint job (#499)
- Loading branch information
1 parent
1add41a
commit 6770536
Showing
110 changed files
with
3,595 additions
and
3,110 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
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,35 +1,45 @@ | ||
# 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 coreth, please fork, fix, commit and send a | ||
If you'd like to contribute to subnet-evm, 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 guidelines: | ||
|
||
* Code must adhere to the official Go | ||
[formatting](https://golang.org/doc/effective_go.html#formatting) guidelines | ||
(i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). | ||
* Code must be documented adhering to the official Go | ||
[commentary](https://golang.org/doc/effective_go.html#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" | ||
Please make sure your contributions adhere to our coding and documentation | ||
guidelines: | ||
|
||
- Code must adhere to the official Go | ||
[formatting](https://golang.org/doc/effective_go.html#formatting) guidelines | ||
(i.e. uses [gofmt](https://golang.org/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://golang.org/doc/effective_go.html#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. | ||
|
||
## 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,25 @@ | ||
--- | ||
name: Release Checklist | ||
about: Create a ticket to track a release | ||
title: '' | ||
labels: release | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Release** | ||
The release version and a description of the planned changes to be included in the release. | ||
|
||
**Issues** | ||
Link the major issues planned to be included in the release. | ||
|
||
**Documentation** | ||
Link the relevant documentation PRs for this release. | ||
|
||
**Checklist** | ||
- [ ] Update version in scripts/versions.sh and plugin/evm/version.go | ||
- [ ] Bump AvalancheGo dependency for RPCChainVM Compatibility | ||
- [ ] Add new entry in compatibility.json for RPCChainVM Compatibility | ||
- [ ] Update AvalancheGo compatibility in README | ||
- [ ] Bump cmd/simulator go mod (if needed) | ||
- [ ] Confirm goreleaser job has successfully generated binaries by checking the releases page |
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,3 +3,5 @@ | |
## How this works | ||
|
||
## How this was tested | ||
|
||
## How is this documented |
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.