Skip to content

Commit

Permalink
chore: update templates (#517)
Browse files Browse the repository at this point in the history
Update general template and add more to description about providing repo links
  • Loading branch information
bxpana authored May 9, 2024
1 parent 6de0981 commit af5d83e
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 65 deletions.
10 changes: 5 additions & 5 deletions .github/DISCUSSION_TEMPLATE/Compilers.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ body:
value: |
## Check the docs!
Have you check these sections of the docs?
- [Compiler zksolc](https://era.zksync.io/docs/api/compiler-toolchain/solidity.html)
- [Compiler zkvyper](https://era.zksync.io/docs/api/compiler-toolchain/vyper.html)
- [Configure hardhat-zksolc](https://era.zksync.io/docs/api/hardhat/hardhat-zksync-solc.html)
- [Configure hardhat-zkvyper](https://era.zksync.io/docs/api/hardhat/hardhat-zksync-vyper.html)
- [Compiler zksolc](https://docs.zksync.io/zk-stack/components/compiler/toolchain/solidity.html)
- [Compiler zkvyper](https://docs.zksync.io/zk-stack/components/compiler/toolchain/vyper.html)
- [Configure hardhat-zksolc](https://docs.zksync.io/build/tooling/hardhat/hardhat-zksync-solc.html)
- [Configure hardhat-zkvyper](https://docs.zksync.io/build/tooling/hardhat/hardhat-zksync-vyper.html)
- type: checkboxes
attributes:
label: Which compiler are you using?
Expand Down Expand Up @@ -43,6 +43,6 @@ body:
id: repo
attributes:
label: Link to your repo?
description: Link to the repo with the contracts and config file
description: Though not mandatory, sharing a repository link with a README that details how to replicate the issue and the errors you're encountering will significantly expedite our support process.
validations:
required: false
2 changes: 1 addition & 1 deletion .github/DISCUSSION_TEMPLATE/Contract-Verification.yml
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ body:
id: repo-link
attributes:
label: Repo Link (Optional)
description: If applicable, please provide a link to a repo
description: Though not mandatory, sharing a repository link with a README that details how to replicate the issue and the errors you're encountering will significantly expedite our support process.
validations:
required: false

Expand Down
2 changes: 1 addition & 1 deletion .github/DISCUSSION_TEMPLATE/Deployments.yml
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ body:
id: repo-link
attributes:
label: Repo Link (Optional)
description: If applicable, please provide a link to a repo
description: Though not mandatory, sharing a repository link with a README that details how to replicate the issue and the errors you're encountering will significantly expedite our support process.
validations:
required: false

Expand Down
59 changes: 4 additions & 55 deletions .github/DISCUSSION_TEMPLATE/General.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,10 @@ body:
attributes:
value: |
## Check the docs!
Before proceeding, please check these links for contract verification help:
Before proceeding, please check these links for general help:
- [Differences from Ethereum](https://era.zksync.io/docs/dev/building-on-zksync/contracts/differences-with-ethereum.html)
- [Fee mechanism](https://era.zksync.io/docs/dev/developer-guides/transactions/fee-model.html)
- [Tutorials](https://era.zksync.io/docs/dev/tutorials)
- [Changelog](https://era.zksync.io/docs/dev/troubleshooting/changelog.html)
- [Important links](https://era.zksync.io/docs/dev/troubleshooting/important-links.html)
- [FAQ](https://docs.zksync.io/build/support/faq.html)
- type: dropdown
id: environment
Expand All @@ -25,64 +23,15 @@ body:
- type: textarea
id: functionality-description
attributes:
label: Provide a brief description of the functionality you're trying to implement.
validations:
required: true

- type: textarea
id: specific-issue
attributes:
label: What is the specific issue or error you're encountering?
validations:
required: true

- type: textarea
id: error-messages
attributes:
label: Can you share the error messages or logs you're receiving, if any?
validations:
required: true

- type: textarea
id: recent-changes
attributes:
label: Have you made any recent changes to the contract before encountering this issue?
validations:
required: true

- type: textarea
id: external-libraries
attributes:
label: Are there any external libraries or contracts that your contract interacts with?
validations:
required: true

- type: textarea
id: contract-code
attributes:
label: Can you provide the relevant portions of your contract code where the issue is occurring?
validations:
required: true

- type: textarea
id: isolation-results
attributes:
label: Have you tried to isolate the problem, and if so, what were the results?
validations:
required: true

- type: textarea
id: resolution-steps
attributes:
label: What steps have you already taken to try to resolve the issue?
label: Provide a brief description of the functionality you're trying to implement and the issue you are running into.
validations:
required: true

- type: input
id: repo-link
attributes:
label: Repo Link (Optional)
description: If applicable, please provide a link to a repo
description: Though not mandatory, sharing a repository link with a README that details how to replicate the issue and the errors you're encountering will significantly expedite our support process.
validations:
required: false

Expand Down
2 changes: 1 addition & 1 deletion .github/DISCUSSION_TEMPLATE/SDKs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,6 @@ body:
id: repo-link
attributes:
label: Repo Link (Optional)
description: If applicable, please provide a link to a repo
description: Though not mandatory, sharing a repository link with a README that details how to replicate the issue and the errors you're encountering will significantly expedite our support process.
validations:
required: false
4 changes: 2 additions & 2 deletions .github/DISCUSSION_TEMPLATE/show-and-tell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,14 @@ body:
attributes:
label: What specific feedback are you looking for?
validations:
required: true
required: false

- type: textarea
id: community-help
attributes:
label: How can the community help or contribute to your project?
validations:
required: true
required: false

- type: textarea
id: additional-info
Expand Down

0 comments on commit af5d83e

Please sign in to comment.