-
-
Notifications
You must be signed in to change notification settings - Fork 86
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #59 from klonyyy/devel
0.5.0 Release
- Loading branch information
Showing
167 changed files
with
120,302 additions
and
118,508 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| <!-- omit in toc --> | ||
| # Contributing to STMViewer | ||
|
|
||
| First off, thanks for taking the time to contribute! ❤️ | ||
|
|
||
| All types of contributions are encouraged and valued. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉 | ||
|
|
||
| > And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about: | ||
| > - Star the project | ||
| > - Tweet about it | ||
| > - Refer this project in your project's readme | ||
| > - Mention the project at local meetups and tell your friends/colleagues | ||
| ## I Have a Question | ||
|
|
||
| > If you want to ask a question, we assume that you have read the [README file](https://github.com/klonyyy/STMViewer/blob/devel/README.md). | ||
| Before you ask a question, it is best to search for existing [Issues](https://github.com/klonyyy/STMViewer/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first. | ||
|
|
||
| If you then still feel the need to ask a question and need clarification, we recommend to open an [Issue](https://github.com/klonyyy/STMViewer/issues/new). | ||
|
|
||
| <!-- omit in toc --> | ||
| ### Submitting a Bug Report | ||
|
|
||
| A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible. | ||
|
|
||
| - Make sure that you are using the latest version. | ||
| - Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [README file](https://github.com/klonyyy/STMViewer/blob/devel/README.md). | ||
| - To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/klonyyy/STMViewer/issues?q=label%3Abug). | ||
| - If the issue is new please open an [Issue](https://github.com/klonyyy/STMViewer/issues/new). | ||
|
|
||
| <!-- omit in toc --> | ||
| ### Before Submitting an Enhancement | ||
|
|
||
| - Make sure that you are using the latest version. | ||
| - Perform a [search](https://github.com/klonyyy/STMViewer/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. | ||
| - Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library. | ||
|
|
||
| <!-- omit in toc --> | ||
| ### How Do I Submit a Good Enhancement Suggestion? | ||
|
|
||
| Enhancement suggestions are tracked as [GitHub issues](https://github.com/klonyyy/STMViewer/issues). | ||
|
|
||
| - Use a **clear and descriptive title** for the issue to identify the suggestion. | ||
| - Provide a **step-by-step description of the suggested enhancement** in as many details as possible. | ||
| - **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you. | ||
| - You may want to **include screenshots or screen recordings** which help you demonstrate the steps or point out the part which the suggestion is related to. | ||
| - **Explain why this enhancement would be useful** to most STMViewer users. You may also want to point out the other projects that solved it better and which could serve as inspiration. | ||
|
|
||
|
|
||
| ## Styleguides | ||
|
|
||
| ### Code Formatting | ||
| Code formatting should be done before submitting any pull requests and performed using clang-format with the .clang-format settings file from repository's main directory. | ||
|
|
||
| ### Commit Messages | ||
| Please adhere to the ongoing commit message convention: | ||
| Use one of the tags: | ||
| - **docs** - for commits to documentation, changing comments in the code etc. | ||
| - **style** - for commits that change the formatting | ||
| - **refactor** - for refactor commits (make sure no new features are introduced) | ||
| - **fix** - for commits that fix stuff | ||
| - **feature** - for completed feature that must compile without errors | ||
| - **wip** - for work in progress (for example on fixing a bug or working on a new feature) | ||
|
|
||
| the message should always start lower case. | ||
|
|
||
| example: | ||
| `fix: fixed a bug` | ||
| `refactor: refactored module XXX` | ||
|
|
||
| ## Attribution | ||
| This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| blank_issues_enabled: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| name: "Ask a question, report a bug, request a feature, etc." | ||
| description: "Ask any question, discuss best practices, report a bug, request a feature." | ||
| body: | ||
| - type: input | ||
| id: specs_version | ||
| attributes: | ||
| label: "Version/Branch:" | ||
| placeholder: "eg. Version 0.4.0, Branch: main" | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: os | ||
| attributes: | ||
| label: "Operating system:" | ||
| placeholder: "e.g. Windows 11, Ubuntu 22.04" | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: probe | ||
| attributes: | ||
| label: "Debug probe:" | ||
| placeholder: "e.g. ST-Link V2, ST-Link V3 MINIE, J-Link Ultra" | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: issue_description | ||
| attributes: | ||
| label: "Details:" | ||
| value: | | ||
| **My Issue/Question:** | ||
| Please provide as much context as possible | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: screenshots | ||
| attributes: | ||
| label: "Screenshots/Video:" | ||
| placeholder: "**Drag files here** | ||
| Attach screenshots or gif/videos to clarify the context. They often convey useful information that is omitted by the description." | ||
| validations: | ||
| required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| { | ||
| // Use IntelliSense to learn about possible attributes. | ||
| // Hover to view descriptions of existing attributes. | ||
| // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 | ||
| "version": "0.2.0", | ||
| "configurations": [ | ||
| { | ||
| "name": "(gdb) Launch", | ||
| "type": "cppdbg", | ||
| "request": "launch", | ||
| "program": "${workspaceFolder}/build/STMViewer", | ||
| "args": [], | ||
| "stopAtEntry": false, | ||
| "cwd": "${workspaceFolder}/build", | ||
| "environment": [], | ||
| "externalConsole": false, | ||
| "MIMode": "gdb", | ||
| "miDebuggerPath": "C:/msys64/mingw64/bin/gdb.exe", | ||
| "setupCommands": [ | ||
| { | ||
| "description": "Enable pretty-printing for gdb", | ||
| "text": "-enable-pretty-printing", | ||
| "ignoreFailures": true | ||
| }, | ||
| { | ||
| "description": "Set Disassembly Flavor to Intel", | ||
| "text": "-gdb-set disassembly-flavor intel", | ||
| "ignoreFailures": true | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "name": "(gdb) tests debug", | ||
| "type": "cppdbg", | ||
| "request": "launch", | ||
| "program": "${workspaceFolder}/build_test/test/STMViewer_test", | ||
| "args": [], | ||
| "stopAtEntry": false, | ||
| "cwd": "${workspaceFolder}/build", | ||
| "environment": [], | ||
| "externalConsole": false, | ||
| "MIMode": "gdb", | ||
| "miDebuggerPath": "C:/msys64/mingw64/bin/gdb.exe", | ||
| "setupCommands": [ | ||
| { | ||
| "description": "Enable pretty-printing for gdb", | ||
| "text": "-enable-pretty-printing", | ||
| "ignoreFailures": true | ||
| }, | ||
| { | ||
| "description": "Set Disassembly Flavor to Intel", | ||
| "text": "-gdb-set disassembly-flavor intel", | ||
| "ignoreFailures": true | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "name": "Remote Debug", | ||
| "type": "cppdbg", | ||
| "request": "launch", | ||
| "program": "${workspaceFolder}/build/STMViewer", | ||
| "stopAtEntry": false, | ||
| "cwd": "${workspaceFolder}/build", | ||
| "environment": [], | ||
| "externalConsole": true, | ||
| "MIMode": "gdb", | ||
| "miDebuggerPath": "C:/msys64/mingw64/bin/gdb.exe", | ||
| "miDebuggerServerAddress": "localhost:2000", | ||
| "setupCommands": [ | ||
| { | ||
| "text": "-enable-pretty-printing", | ||
| "ignoreFailures": true | ||
| } | ||
| ], | ||
| "preLaunchTask": "Run application with gdbserver" | ||
| }, | ||
| { | ||
| "name": "Remote Debug Attach", | ||
| "type": "cppdbg", | ||
| "request": "attach", | ||
| "program": "${workspaceFolder}/build/STMViewer", | ||
| "processId": "${command:pickProcess}", | ||
| "MIMode": "gdb", | ||
| "useExtendedRemote": true, | ||
| "miDebuggerPath": "C:/msys64/mingw64/bin/gdb.exe", | ||
| "miDebuggerServerAddress": "localhost:2000", | ||
| "setupCommands": [ | ||
| { | ||
| "text": "-enable-pretty-printing", | ||
| "ignoreFailures": true | ||
| } | ||
| ], | ||
| "logging": { | ||
| "engineLogging": true, | ||
| } | ||
| }, | ||
| { | ||
| "name": "Remote Debug Tests", | ||
| "type": "cppdbg", | ||
| "request": "launch", | ||
| "program": "${workspaceFolder}/build_test/test/STMViewer_test", | ||
| "stopAtEntry": false, | ||
| "cwd": "${workspaceFolder}/build", | ||
| "environment": [], | ||
| "externalConsole": true, | ||
| "MIMode": "gdb", | ||
| "miDebuggerPath": "C:/msys64/mingw64/bin/gdb.exe", | ||
| "miDebuggerServerAddress": "localhost:2000", | ||
| "setupCommands": [ | ||
| { | ||
| "text": "-enable-pretty-printing", | ||
| "ignoreFailures": true | ||
| } | ||
| ], | ||
| "preLaunchTask": "Run application with gdbserver" | ||
| }, | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| { | ||
| "files.associations": { | ||
| "memory": "cpp", | ||
| "array": "cpp", | ||
| "atomic": "cpp", | ||
| "bit": "cpp", | ||
| "cctype": "cpp", | ||
| "clocale": "cpp", | ||
| "cmath": "cpp", | ||
| "compare": "cpp", | ||
| "concepts": "cpp", | ||
| "cstddef": "cpp", | ||
| "cstdint": "cpp", | ||
| "cstdio": "cpp", | ||
| "cstdlib": "cpp", | ||
| "cstring": "cpp", | ||
| "ctime": "cpp", | ||
| "cwchar": "cpp", | ||
| "exception": "cpp", | ||
| "fstream": "cpp", | ||
| "functional": "cpp", | ||
| "initializer_list": "cpp", | ||
| "ios": "cpp", | ||
| "iosfwd": "cpp", | ||
| "iostream": "cpp", | ||
| "istream": "cpp", | ||
| "iterator": "cpp", | ||
| "limits": "cpp", | ||
| "list": "cpp", | ||
| "map": "cpp", | ||
| "mutex": "cpp", | ||
| "new": "cpp", | ||
| "ostream": "cpp", | ||
| "ratio": "cpp", | ||
| "sstream": "cpp", | ||
| "stdexcept": "cpp", | ||
| "stop_token": "cpp", | ||
| "streambuf": "cpp", | ||
| "string": "cpp", | ||
| "system_error": "cpp", | ||
| "thread": "cpp", | ||
| "tuple": "cpp", | ||
| "type_traits": "cpp", | ||
| "typeinfo": "cpp", | ||
| "unordered_map": "cpp", | ||
| "utility": "cpp", | ||
| "vector": "cpp", | ||
| "xfacet": "cpp", | ||
| "xhash": "cpp", | ||
| "xiosbase": "cpp", | ||
| "xlocale": "cpp", | ||
| "xlocinfo": "cpp", | ||
| "xlocnum": "cpp", | ||
| "xmemory": "cpp", | ||
| "xstddef": "cpp", | ||
| "xstring": "cpp", | ||
| "xtr1common": "cpp", | ||
| "xtree": "cpp", | ||
| "xutility": "cpp", | ||
| "algorithm": "cpp", | ||
| "charconv": "cpp", | ||
| "chrono": "cpp", | ||
| "format": "cpp", | ||
| "forward_list": "cpp", | ||
| "iomanip": "cpp", | ||
| "locale": "cpp", | ||
| "optional": "cpp", | ||
| "xlocbuf": "cpp", | ||
| "xlocmes": "cpp", | ||
| "xlocmon": "cpp", | ||
| "xloctime": "cpp", | ||
| "random": "cpp", | ||
| "bitset": "cpp", | ||
| "regex": "cpp", | ||
| "set": "cpp", | ||
| "condition_variable": "cpp", | ||
| "cstdarg": "cpp", | ||
| "span": "cpp", | ||
| "any": "cpp", | ||
| "deque": "cpp", | ||
| "numeric": "cpp", | ||
| "unordered_set": "cpp", | ||
| "variant": "cpp", | ||
| "tracereadernewcpp": "cpp", | ||
| "filesystem": "cpp", | ||
| "coroutine": "cpp", | ||
| "resumable": "cpp", | ||
| "future": "cpp" | ||
| } | ||
| } |
Oops, something went wrong.