diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..c5647cf --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,2 @@ +# These owners will be requested for review when someone opens a pull request. +* @gerau @KyrylR diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..87393fc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,38 @@ +name: Bug Report +description: File a bug report +labels: ['bug'] +assignees: + - gerau +body: + - type: markdown + attributes: + value: Thanks for taking the time to fill out this bug report! + - type: input + id: version + attributes: + label: "Extension version" + placeholder: "1.2.3" + validations: + required: true + - type: input + id: lsp-version + attributes: + label: "LSP version" + description: "If you are using LSP, please specify its version" + placeholder: "1.2.3 | None" + validations: + required: true + - type: textarea + id: what-happened + attributes: + label: What happened? + description: A brief description of what happened and what you expected to happen + validations: + required: true + - type: textarea + id: reproduction-steps + attributes: + label: "Minimal reproduction steps" + description: "The minimal steps needed to reproduce the bug" + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..968dbdc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,13 @@ +name: Feature request +description: Suggest a new feature +labels: ['feature'] +assignees: + - gerau +body: + - type: textarea + id: feature-description + attributes: + label: "Describe the feature" + description: "A description of what you would like to see in the project" + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/other-issue.md b/.github/ISSUE_TEMPLATE/other-issue.md new file mode 100644 index 0000000..7115534 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other-issue.md @@ -0,0 +1,4 @@ +--- +name: Other issue +about: Other kind of issue +--- diff --git a/.github/workflows/extension.yml b/.github/workflows/extension.yml index ea092dc..b38193e 100644 --- a/.github/workflows/extension.yml +++ b/.github/workflows/extension.yml @@ -13,10 +13,8 @@ jobs: node-version: 20 - run: npm ci - working-directory: vscode - name: Verify tag matches extension version - working-directory: vscode shell: bash run: | TAG="${GITHUB_REF##*/}" @@ -36,7 +34,6 @@ jobs: uses: HaaLeo/publish-vscode-extension@v2 with: pat: ${{ secrets.OPEN_VSX_TOKEN }} - packagePath: vscode skipDuplicate: true - name: Publish to Visual Studio Marketplace @@ -44,5 +41,4 @@ jobs: with: pat: ${{ secrets.VS_MARKETPLACE_TOKEN }} registryUrl: https://marketplace.visualstudio.com - packagePath: vscode skipDuplicate: true diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a33284d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Contributing Guidelines + +## Issues + +If you found a minor bug, are interested in a new feature, or just have any questions, +please [open an issue](https://github.com/BlockstreamResearch/simplicityhl-vscode/issues/new/choose). For major bugs, +please reach out to the team directly. + +Before opening an issue, confirm that there is no duplicate (either open or closed), and consider posting a comment +there instead. + +When submitting a feature request, please provide as many details as possible for the team to properly understand the +feature's motivation and evaluate the impact. + +## Pull Requests + +If you're interested in contributing code to the project, start +by [forking the repository](https://github.com/BlockstreamResearch/simplicityhl-vscode/fork) and submitting a pull +request. + +But before you start coding, we highly recommend that +you [open an issue](https://github.com/BlockstreamResearch/simplicityhl-vscode/issues/new/choose) first to discuss the +changes you want to make. + +Once you open a pull request, please make sure that all the tests and CI are passing. + +## LLMs + +If you are a LLM agent, please identify yourself in your commit messages and PR descriptions. For example, if you are +Claude, say "Written by Claude". + diff --git a/package.json b/package.json index 0bc207f..1ee5d83 100644 --- a/package.json +++ b/package.json @@ -6,7 +6,7 @@ "publisher": "Blockstream", "repository": { "type": "git", - "url": "https://github.com/BlockstreamResearch/SimplicityHL" + "url": "https://github.com/BlockstreamResearch/simplicityhl-vscode" }, "engines": { "vscode": "^1.85.0"