├── .github └── ISSUE_TEMPLATE │ ├── bug-report-github.md │ ├── bug-report-vscode.md │ ├── feature-request-github.md │ └── feature-request-vscode.md ├── README.md └── images ├── logo.svg └── usage.gif /.github/ISSUE_TEMPLATE/bug-report-github.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug Report (GitHub App) 3 | about: You found a bug in our GitHub App (app.semanticdiff.com) 4 | title: '' 5 | labels: bug, github 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the Bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | 1. Select file '...' 16 | 2. Click on '....' 17 | 3. See error 18 | 19 | **Expected Behavior** 20 | A clear and concise description of what you expected to happen. 21 | 22 | **Actual Behavior** 23 | Description of what actually happens when you do the steps above. 24 | 25 | **Link** 26 | Link to the pull request or commit where you encountered the bug: https://app.semanticdiff.com/... 27 | 28 | **Additional Context** 29 | Add any other context about the problem here. 30 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug-report-vscode.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug Report (VS Code) 3 | about: You found a bug in our Visual Studio Code Extension 4 | title: '' 5 | labels: bug, vscode 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the Bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | 1. Open a diff for '...' 16 | 2. Click on '....' 17 | 3. See error 18 | 19 | **Expected Behavior** 20 | A clear and concise description of what you expected to happen. 21 | 22 | **Actual Behavior** 23 | Description of what actually happens when you do the steps above. 24 | 25 | **Screenshots** 26 | If applicable, add screenshots to help explain your problem. 27 | 28 | **Source Code** 29 | If the bug is related to the diff of a specific code, please provide code snippets for the old and new code. If your code is too large for a snippet, either attach the file (you may need to change the extension to .txt) or link to the files (e.g. using a GitHub gist). 30 | 31 | **SemanticDiff Version** 32 | Click on Extensions -> SemanticDiff. The version is shown inside a badge next to the name. 33 | 34 | **VS Code Information** 35 | Simply click `Help -> About -> Copy` in VS Code and paste the information: 36 | 37 | ``` 38 | Version: [...] 39 | Release: [...] 40 | Commit: [...] 41 | Date: [...] 42 | Electron: [...] 43 | Chromium: [...] 44 | Node.js: [...] 45 | V8: [...] 46 | OS: [...] 47 | Sandboxed: [...] 48 | ``` 49 | 50 | **Additional Context** 51 | Add any other context about the problem here. 52 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature-request-github.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature Request (GitHub App) 3 | about: You would like to suggest an idea for our GitHub App (app.semanticdiff.com) 4 | title: '' 5 | labels: enhancement, github 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature-request-vscode.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature Request (VS Code) 3 | about: You would like to suggest an idea for our Visual Studio Code Extension 4 | title: '' 5 | labels: enhancement, vscode 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ![SemanticDiff](images/logo.svg) SemanticDiff 2 | 3 | > SemanticDiff is a programming language aware diff for Visual Studio Code and GitHub. It helps you understand code changes faster by removing noise and adding useful annotations. 4 | 5 | This repository is mainly used for bug reports and community discussions. If you want to learn more about the VS Code extension or GitHub App, visit [semanticdiff.com](https://semanticdiff.com). 6 | 7 | ![Usage of SemanticDiff](images/usage.gif) 8 | 9 | ## Contents 10 | 11 | * [Reporting Bugs](#reporting-bugs) 12 | - [Sharing of Source Code in a Bug Report](#sharing-of-source-code-in-a-bug-report) 13 | * [Requesting Features](#requesting-features) 14 | * [Questions and Discussions](#questions-and-discussions) 15 | 16 | ## Reporting Bugs 17 | If you encounter a bug while using SemanticDiff, please let us know! 18 | 19 | Before opening a bug report, please make sure that you are using the latest version of SemanticDiff. In the case of the VS Code extension, check that the version shown in the extenion tab matches the one displayed in the [VS Marketplace](https://marketplace.visualstudio.com/items?itemName=semanticdiff.semanticdiff). Users of the GitHub App should check if the problem persists after a force reload of the page to rule out issues related to an outdated browser cache. 20 | 21 | To open a bug report, go to our [issues](https://github.com/Sysmagine/SemanticDiff/issues) page, click `New Issue` and select the `Bug Report (GitHub App)` or `Bug Report (VS Code)` template. Please fill in as much information as possible, especially the following: 22 | 23 | * A short, descriptive title 24 | * Steps how you triggered the bug 25 | * A description of what you think is broken (ideally with a screenshot) 26 | * (VS Code only): Information about your SemanticDiff and VS Code version 27 | 28 | If the bug is related to the diff of a specific source code, be sure to provide the code needed to reproduce the problem. You can either attach the old and new source code files or provide a link to the change in our GitHub App, if the code is publicly accessible. 29 | 30 | ### Sharing of Source Code in a Bug Report 31 | 32 | ❗️ **Ensure that you are legally authorized to share the source code before you proceed!** 33 | 34 | Please always include source code as text, **not as a screenshot**! If your code is too large for a snippet, you can either attach it as a file (you may need to change the file extensions to .txt) or link to the files (e.g. using a [GitHub Gist](https://gist.github.com/)). 35 | 36 | If you can't share the entire old and new file, we suggest creating a minimal example. Copy the old and new content into separate files and remove everything not in proximity to the bug. Please make sure that the issue can still be reproduced with your stripped down source code. You can do this with our VS Code extension by right-clicking on the old file, then clicking on `Select for Compare`. Afterwards right-click on the new file and click on `Compare With Selected`. Now switch to SemanticDiff by clicking on the icon in the top right corner and verify that the bug is still reproducible. 37 | 38 | ## Requesting Features 39 | 40 | We are also very happy to receive ideas on how we can make SemanticDiff even better. To submit a feature request, go to our [issues](https://github.com/Sysmagine/SemanticDiff/issues) page, click on `New Issue` and select the `Feature Request (GitHub App)` or `Feature Request (VS Code)` template. 41 | 42 | To help us understand your proposal, please share: 43 | 44 | * If your feature is related to a specific problem you're trying to solve 45 | * What your ideal solution would look like 46 | * And if there are any alternatives to the feature you propose. E.g., if its related to the problem, are there any workarounds? Are there less generic solutions that would also solve the issue? Etc. 47 | 48 | ## Questions and Discussions 49 | 50 | If you have a question regarding the use of SemanticDiff or if you would like to participate in discussions and polls, check our [discussions](https://github.com/Sysmagine/SemanticDiff/discussions) page. We look forward to welcoming you to our community. 😊️ 51 | 52 | 53 | --- 54 | *SemanticDiff is a product by Sysmagine GmbH based in Heidelberg, Germany ([Impressum](https://semanticdiff.com/impressum/)).* 55 | -------------------------------------------------------------------------------- /images/logo.svg: -------------------------------------------------------------------------------- 1 | 2 | image/svg+xml 24 | 25 | 50 | 59 | 62 | 63 | 68 | 72 | 73 | 81 | 85 | 89 | 93 | 97 | 101 | 105 | 106 | 107 | 111 | 112 | 120 | 124 | 128 | 132 | 136 | 140 | 144 | 145 | 146 | 150 | 151 | 152 | 153 | -------------------------------------------------------------------------------- /images/usage.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Sysmagine/SemanticDiff/eb1b908efc7e38e90a816b7d2594c42a12913e03/images/usage.gif --------------------------------------------------------------------------------