kopia lustrzana https://github.com/stlink-org/stlink
General Project Update
- Updated issue templates - Updated CONTRIBUTING.md (Closes #906) - Updated changelogs for deb and rpm packages - Updated CHANGELOG.mdpull/1140/head
nightwalker-87
rodzic
b97296be8f
commit
80c31a15a4
|
|
@ -5,14 +5,19 @@ title: "[STM32 device name]: $YourTitle"
|
|||
labels: ""
|
||||
---
|
||||
|
||||
Thank you for giving feedback to the stlink project.
|
||||
**Thank you for giving feedback to the stlink project.**
|
||||
|
||||
**NOTICE: Please read and follow instructions in #906 before submitting a ticket.
|
||||
This bug report will be deleted without notice when not enough information is provided! So please ensure that all fields are filled out.**
|
||||
---
|
||||
|
||||
**NOTE: In order to offer sufficient and the best possible support, please read /CONTRIBUTING.md and follow the given instructions _before_ submitting a ticket.**
|
||||
|
||||
**Bug reports and/or feature requests will be deleted, if they violate our contribution guidelines and if no issue-template is used!** Thank you for your support.
|
||||
|
||||
---
|
||||
|
||||
- [ ] I made serious effort to avoid creating duplicate or nearly similar issue
|
||||
|
||||
In order to allow developers and other contributors to isolate and target your respective issue, please take some time to select the check boxes below and fill out each of the following items appropriate to your specific problem.
|
||||
In order to allow developers to isolate and target your respective issue, please take some time to select the check boxes below and fill out each of the following items appropriate to your specific problem.
|
||||
|
||||
- [ ] Programmer/board type: [enter here] (e.g STLINK /V1, /V2, /V2-onboard, /V2-clone, /V3)
|
||||
- [ ] Operating system an version: [enter here] (e.g Linux, macOS, Windows)
|
||||
|
|
@ -31,7 +36,3 @@ OUTPUT/ERROR of the commandline tool(s)
|
|||
Expected/description:
|
||||
|
||||
`short description of the expected value`
|
||||
|
||||
Thank you for your support.
|
||||
|
||||
The stlink project maintainers
|
||||
|
|
|
|||
|
|
@ -5,14 +5,19 @@ title: "[feature] $YourTitle"
|
|||
labels: code/feature-request
|
||||
---
|
||||
|
||||
Thank you for giving feedback to the stlink project.
|
||||
**Thank you for giving feedback to the stlink project.**
|
||||
|
||||
**NOTICE: Please read and follow instructions in #906 before submitting a ticket.
|
||||
This feature request will be deleted without notice when not enough information is provided! So please ensure that all fields are filled out.**
|
||||
---
|
||||
|
||||
**NOTE: In order to offer sufficient and the best possible support, please read /CONTRIBUTING.md and follow the given instructions _before_ submitting a ticket.**
|
||||
|
||||
**Bug reports and/or feature requests will be deleted, if they violate our contribution guidelines and if no issue-template is used!** Thank you for your support.
|
||||
|
||||
---
|
||||
|
||||
- [ ] I made serious effort to avoid creating duplicate or nearly similar issue
|
||||
|
||||
In order to allow developers and other contributors to isolate and target your respective issue, please take some time to select the check boxes below and fill out each of the following items appropriate to your specific request.
|
||||
In order to allow developers to isolate and target your respective issue, please take some time to select the check boxes below and fill out each of the following items appropriate to your specific request.
|
||||
|
||||
- [ ] Programmer/board type: [enter here] (e.g STLINK /V1, /V2, /V2-onboard, /V2-clone, /V3)
|
||||
- [ ] Operating system an version: [enter here] (e.g Linux, macOS, Windows)
|
||||
|
|
@ -31,7 +36,3 @@ OUTPUT/ERROR of the commandline tool(s)
|
|||
Expected/description:
|
||||
|
||||
`short description of the expected value`
|
||||
|
||||
Thank you for your support.
|
||||
|
||||
The stlink project maintainers
|
||||
|
|
|
|||
12
CHANGELOG.md
12
CHANGELOG.md
|
|
@ -1,5 +1,17 @@
|
|||
# stlink Changelog
|
||||
|
||||
# v1.7.1
|
||||
|
||||
Release date: 2021-xx-xx
|
||||
|
||||
Features:
|
||||
|
||||
Updates & changes:
|
||||
|
||||
- Added instructions for bug-reports and feature-requests to contribution guidelines ([#906](https://github.com/stlink-org/stlink/pull/906))
|
||||
|
||||
Fixes:
|
||||
|
||||
# v1.7.0
|
||||
|
||||
Release date: 2021-04-25
|
||||
|
|
|
|||
|
|
@ -12,6 +12,17 @@ We love your input! We want to make contributing to this project as easy and tra
|
|||
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
|
||||
Report a bug by [opening a new issue]() with one of the available templates. It's that easy!
|
||||
|
||||
**NOTE: In order to offer sufficient and the best possible support, please read and follow the instructions below before submitting a ticket:**
|
||||
|
||||
1) If using a ST-Link-v2 programmer: Convince yourself that it is recognised as an USB device by your computer, thus reporting device and manufacturer ID. Use a diagnostic tool to probe for enumerated USB devices, e.g [`lsusb -v`](https://linux.die.net/man/8/lsusb) on unix-based systems.
|
||||
2) **Use the [ST-Link firmware upgrade tool](https://www.st.com/en/development-tools/stsw-link007.html) based on Java to read out the current firmware version and update to the latest available version. This also works for _non-genuine_ ST programmers and boards.**
|
||||
3) Try to make sure you have a working toolchain before starting to build.
|
||||
4) **Update to the _latest_ release version or maybe even use the `develop` branch.**
|
||||
5) Search for your problem in the available open issues, _before_ opening a new ticket.
|
||||
6) Make sure to **use the available issue templates** to submit a bug-report or a feature-request. **Do not replace the prepared text, edit the placeholders instead. _Describe_ your problem.**
|
||||
7) Avoid to add new comments to closed issues unless they confirm a solution already available.
|
||||
8) Don't comment on tickets which do not specifically address your device or hardware - open a new ticket instead.
|
||||
9) Consider if you can help to solve other issues (e.g. you have the same hardware)
|
||||
|
||||
## Coding conventions
|
||||
To read code written by other contributors can turn out to be quite demanding - a variable which seems to self-explaining, may appear cryptic to other readers. If you plan to contribute, please take this into account and feel encouraged to help others understand your code. In order to help you along, we have composed some contribution guidelines for this project. As this project already has a history you may find parts in the codebase that do not seem to comply with these guidelines, but we are trying to improve continuosly. However we can do even better, if every contributor considers the following points:
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
stlink (1.7.0) unstable; urgency=medium
|
||||
|
||||
* Release v1.7.0
|
||||
|
||||
-- Nightwalker-87 <stlink-org> Sun, 25 Apr 2021 00:00:00 +0100
|
||||
|
||||
stlink (1.6.1) unstable; urgency=medium
|
||||
|
||||
* Initial cpack-based package release for Debian/Ubuntu
|
||||
|
|
|
|||
|
|
@ -1,2 +1,5 @@
|
|||
* Sun Apr 25 2021 Nightwalker-87 <stlink-org> - 1.7.0
|
||||
- Release v1.7.0
|
||||
|
||||
* Mon Jun 01 2020 Nightwalker-87 <stlink-org> - 1.6.1
|
||||
- Initial cpack-based RPM package release
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ Release
|
|||
|
||||
This document describes the necessary steps for developers to create a release:
|
||||
|
||||
1. Update `CHANGELOG.md`
|
||||
1. Update `CHANGELOG.md`, `cmake/packaging/deb/changelog` & `cmake/packaging/rpm/changelog`
|
||||
2. Update `.version` with semantic version: `x.x.x`
|
||||
3. Update `README.md` with semantic version `x.x.x` in commits badge
|
||||
4. Create and push git tag and commits `git tag x.x.x`
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue