Skip to content

Commit

Permalink
Updates contributing docs & feedback templates
Browse files Browse the repository at this point in the history
  • Loading branch information
eamodio committed Jul 15, 2022
1 parent b77958d commit a0ed3be
Show file tree
Hide file tree
Showing 5 changed files with 109 additions and 34 deletions.
23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

89 changes: 89 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
name: 🐞 Bug
description: Create a report to help GitLens improve
title: '<title>'
labels: [potential-bug, triage]
body:
- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
validations:
required: false
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: false
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. In this environment...
2. With this config...
3. Run '...'
4. See error...
validations:
required: false
- type: input
id: gitlens
attributes:
label: GitLens Version
description: What version of GitLens are you using?
placeholder: v12.0.0
validations:
required: true
- type: input
id: vscode
attributes:
label: VS Code Version
description: What version of VS Code are you using? Copy from Help -> About
placeholder: |
Version: 1.70.0-insider (user setup)
Commit: 1cd90cceddf3c413673963ab6f154d2ff294b17c
Date: 2022-07-15T05:16:39.110Z
Electron: 18.3.5
Chromium: 100.0.4896.160
Node.js: 16.13.2
V8: 10.0.139.17-electron.0
OS: Windows_NT x64 10.0.22622
validations:
required: true
- type: dropdown
id: vscode-edition
attributes:
label: VS Code Edition
description: What edition of VS Code are you using?
multiple: false
options:
- Desktop
- Web (vscode.dev)
- Web (github.dev)
validations:
required: true
- type: input
id: git
attributes:
label: Git Version
description: 'What version of Git are you using? Use `git --version`'
placeholder: 'git version 2.37.0.windows.1'
validations:
required: true
- type: markdown
value: |
For intermittent issues, please enable debug logging by running the _GitLens: Enable Debug Logging_ command from the Command Palette (<kbd>F1</kbd> or <kbd>ctrl/cmd</kbd>+<kbd>shift</kbd>+<kbd>p</kbd>).
This will enable logging to the _GitLens_ & _GitLens (Git)_ channels in the _Output_ pane.
Once enabled, please reproduce the issue, and attach the logs from the _GitLens_ channel, and if its Git related please also attach the logs from the _GitLens (Git)_ channel.
Thank you!
- type: textarea
attributes:
label: Logs, Screenshots, Screen Captures, etc
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
5 changes: 4 additions & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Question
- name: Q & A
url: https://github.com/gitkraken/vscode-gitlens/discussions?discussions_q=category%3AQ%26A
about: Ask and answer questions about GitLens
- name: GitLens+ Support
url: https://www.gitkraken.com/gitlens-support
about: Get email support for GitLens+ issues and questions
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

- Please create an issue _before_ creating a Pull Request
- Please use the following Git commit message style
- Use the future tense ("Adds feature" not "Added feature")
- Use future tense ("Adds feature" not "Added feature")
- Use a "Fixes #xxx -" or "Closes #xxx -" prefix to auto-close the issue that your PR addresses
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
Expand All @@ -27,6 +27,6 @@ Please include a summary of the changes and which issue will be addressed. Pleas
- [ ] My changes follow the coding style of this project
- [ ] My changes build without any errors or warnings
- [ ] My changes have been formatted and linted
- [ ] My changes include any required corresponding changes to the documentation
- [ ] My changes include any required corresponding changes to the documentation (including CHANGELOG.md and README.md)
- [ ] My changes have been rebased and squashed to the minimal number (typically 1) of relevant commits
- [ ] My changes have a descriptive commit message with a short title, including a `Fixes $XXX -` or `Closes #XXX -` prefix to auto-close the issue that your PR addresses
22 changes: 14 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,17 @@ See https://code.visualstudio.com/api/extension-guides/web-extensions#test-your-
3. Run the `build` or `watch` task from the command palette
4. Run the `Run (vscode.dev)` task from the command palette

### Change Log
## Submitting a Pull Request

Please follow all the instructions in the [PR template](.github/PULL_REQUEST_TEMPLATE.md).

### Contributions to GitLens+ Licensed Files

This repository contains both OSS-licensed and non-OSS-licensed files. All files in or under any directory named "plus" fall under LICENSE.plus. The remaining files fall under LICENSE, the MIT license.

If a pull request is submitted which contains changes to files in or under any directory named "plus", then you agree that GitKraken and/or its licensors (as applicable) retain all right, title and interest in and to all such modifications and/or patches.

### Update the CHANGELOG

The [Change Log](CHANGELOG.md) is updated manually and an entry should be added for each change. Changes are grouped in lists by `added`, `changed` or `fixed`.

Expand All @@ -142,15 +152,11 @@ Be sure to give yourself much deserved credit by adding your name and user in th

> - Adds `gitlens.statusBar.alignment` settings to control the alignment of the status bar &mdash; thanks to [PR #72](https://github.com/gitkraken/vscode-gitlens/pull/72) by Zack Schuster ([@zackschuster](https://github.com/zackschuster))!
## Submitting a Pull Request

Please follow all the instructions in the [PR template](.github/PULL_REQUEST_TEMPLATE.md).

### Contributions to GitLens+ Licensed Files
### Update the README

This repository contains both OSS-licensed and non-OSS-licensed files. All files in or under any directory named "plus" fall under LICENSE.plus. The remaining files fall under LICENSE, the MIT license.
If this is your first contribution to GitLens, please give yourself credit by adding yourself to the `Contributors` section of the [README](README.md#contributors-) in the following format:

If a pull request is submitted which contains changes to files in or under any directory named "plus", then you agree that GitKraken and/or its licensors (as applicable) retain all right, title and interest in and to all such modifications and/or patches.
> - `Your Name ([@<your-github-username>](https://github.com/<your-github-username>)) &mdash; [contributions](https://github.com/gitkraken/vscode-gitlens/commits?author=<your-github-username>)`
## Publishing

Expand Down

0 comments on commit a0ed3be

Please sign in to comment.