diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 91% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md index c99dc6305..8f2cb4c9d 100644 --- a/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,7 +1,7 @@ # Contributing to VechainThor Welcome to VechainThor! We appreciate your interest in contributing. By participating in this project, you agree to -abide by our [Code of Conduct](CODE_OF_CONDUCT.md). +abide by our [Code of Conduct](https://github.com/vechain/thor/blob/master/CODE_OF_CONDUCT.md). ## VeChain Improvement Proposals (VIPs) @@ -34,7 +34,7 @@ current development landscape. ```bash make test ``` - - **Note:**: Please refer to the [README](README.md) for information on how to start the node and interact with the + - **Note:**: Please refer to the [README](https://github.com/vechain/thor/blob/master/README.md) for information on how to start the node and interact with the API. 5. Make your changes and commit them with a clear and concise commit message. 6. Push your changes to your forked repository: diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 52154b1c9..000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve - ---- - -Hi there, - -Please notice that this is an issue tracker reserved for bug reports and feature requests. - -For general questions please use the gitter channel. - -## OS Version: -Windows/Linux/OSX - -## Commit hash : (if develop) - -## Expected behavior -Tell us what should happen. - -## Actual behavior -Tell us what happens instead. Provide a log message if relevant. - -## Steps to reproduce the behavior diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000..847202439 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,66 @@ +name: "🐛 Bug Report" +description: Create a new ticket for a bug. +title: "🐛 [BUG] - " +labels: [ +"bug" +] +body: +- type: textarea + id: description + attributes: + label: "Description" + description: Please enter an explicit description of your issue + placeholder: Short and explicit description of your incident... + validations: + required: true +- type: input + id: reprod-url + attributes: + label: "Reproduction URL" + description: Please enter your GitHub URL to provide a reproduction of the issue + placeholder: ex. https://github.com/USERNAME/REPO-NAME + validations: + required: true +- type: textarea + id: reprod + attributes: + label: "Reproduction steps" + description: Please enter an explicit description of your issue + value: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + render: bash + validations: + required: true +- type: textarea + id: screenshot + attributes: + label: "Screenshots" + description: If applicable, add screenshots to help explain your problem. + value: | + ![DESCRIPTION](LINK.png) + render: bash + validations: + required: false +- type: textarea + id: logs + attributes: + label: "Logs" + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: bash + validations: + required: false +- type: dropdown + id: os + attributes: + label: "OS" + description: What is the impacted environment ? + multiple: true + options: + - Windows + - Linux + - Mac + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..2b5017d68 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: VeChain Improvement Proposals (VIPs) + url: https://github.com/vechain/VIPs + about: Use this repository to view existing proposals and feature requests or to submit your own. + - name: Discord + url: https://discord.gg/vechainofficial + about: Join our Discord community to connect with other VeChain enthusiasts, ask questions, and find answers. + - name: Telegram + url: https://t.me/VeChainDevCommunity + about: Join our Telegram community to connect with other VeChain developers, ask questions, and find answers. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..ba23b8f55 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,39 @@ +# Description + +Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change. + +Fixes # (issue) + +## Type of change + +Please delete options that are not relevant. + +- [x] Bug fix (non-breaking change which fixes an issue) +- [x] New feature (non-breaking change which adds functionality) +- [x] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [x] This change requires a documentation update + +# How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration + +- [x] Test A +- [x] Test B + +**Test Configuration**: +* Go Version: +* Hardware: +* Docker Version: + +# Checklist: + +- [x] My code follows the style guidelines of this project +- [x] I have performed a self-review of my code +- [x] I have commented my code, particularly in hard-to-understand areas +- [x] I have made corresponding changes to the documentation +- [x] My changes generate no new warnings +- [x] I have added tests that prove my fix is effective or that my feature works +- [x] New and existing unit tests pass locally with my changes +- [x] New and existing E2E tests pass locally with my changes +- [x] Any dependent changes have been merged and published in downstream modules +- [x] I have not added any vulnerable dependencies to my code diff --git a/.gitignore b/.gitignore index f60fd9923..9667c7a2d 100644 --- a/.gitignore +++ b/.gitignore @@ -27,3 +27,5 @@ package.json .fake_gopath_suffix coverage.out + +.idea diff --git a/README.md b/README.md index 10ccbc9a5..3ecaa84e3 100644 --- a/README.md +++ b/README.md @@ -178,7 +178,7 @@ A special shout out to following projects: ## Contributing -- Please refer to [CONTRIBUTING.md](./CONTRIBUTING.md) on how to contribute to this project. +- Please refer to [CONTRIBUTING.md](https://github.com/vechain/thor/blob/master/.github/CONTRIBUTING.md) on how to contribute to this project. ## License