Skip to content

Commit 80c31a1

Browse files
Nightwalker-87Nightwalker-87
committed
General Project Update
- Updated issue templates - Updated CONTRIBUTING.md (Closes stlink-org#906) - Updated changelogs for deb and rpm packages - Updated CHANGELOG.md
1 parent b97296b commit 80c31a1

File tree

7 files changed

+51
-17
lines changed

7 files changed

+51
-17
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,19 @@ title: "[STM32 device name]: $YourTitle"
55
labels: ""
66
---
77

8-
Thank you for giving feedback to the stlink project.
8+
**Thank you for giving feedback to the stlink project.**
99

10-
**NOTICE: Please read and follow instructions in #906 before submitting a ticket.
11-
This bug report will be deleted without notice when not enough information is provided! So please ensure that all fields are filled out.**
10+
---
11+
12+
**NOTE: In order to offer sufficient and the best possible support, please read /CONTRIBUTING.md and follow the given instructions _before_ submitting a ticket.**
13+
14+
**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.
15+
16+
---
1217

1318
- [ ] I made serious effort to avoid creating duplicate or nearly similar issue
1419

15-
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.
20+
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.
1621

1722
- [ ] Programmer/board type: [enter here] (e.g STLINK /V1, /V2, /V2-onboard, /V2-clone, /V3)
1823
- [ ] Operating system an version: [enter here] (e.g Linux, macOS, Windows)
@@ -31,7 +36,3 @@ OUTPUT/ERROR of the commandline tool(s)
3136
Expected/description:
3237

3338
`short description of the expected value`
34-
35-
Thank you for your support.
36-
37-
The stlink project maintainers

‎.github/ISSUE_TEMPLATE/feature-request.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,19 @@ title: "[feature] $YourTitle"
55
labels: code/feature-request
66
---
77

8-
Thank you for giving feedback to the stlink project.
8+
**Thank you for giving feedback to the stlink project.**
99

10-
**NOTICE: Please read and follow instructions in #906 before submitting a ticket.
11-
This feature request will be deleted without notice when not enough information is provided! So please ensure that all fields are filled out.**
10+
---
11+
12+
**NOTE: In order to offer sufficient and the best possible support, please read /CONTRIBUTING.md and follow the given instructions _before_ submitting a ticket.**
13+
14+
**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.
15+
16+
---
1217

1318
- [ ] I made serious effort to avoid creating duplicate or nearly similar issue
1419

15-
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.
20+
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.
1621

1722
- [ ] Programmer/board type: [enter here] (e.g STLINK /V1, /V2, /V2-onboard, /V2-clone, /V3)
1823
- [ ] Operating system an version: [enter here] (e.g Linux, macOS, Windows)
@@ -31,7 +36,3 @@ OUTPUT/ERROR of the commandline tool(s)
3136
Expected/description:
3237

3338
`short description of the expected value`
34-
35-
Thank you for your support.
36-
37-
The stlink project maintainers

‎CHANGELOG.md

+12
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# stlink Changelog
22

3+
# v1.7.1
4+
5+
Release date: 2021-xx-xx
6+
7+
Features:
8+
9+
Updates & changes:
10+
11+
- Added instructions for bug-reports and feature-requests to contribution guidelines ([#906](https://github.com/stlink-org/stlink/pull/906))
12+
13+
Fixes:
14+
315
# v1.7.0
416

517
Release date: 2021-04-25

‎CONTRIBUTING.md

+11
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,17 @@ We love your input! We want to make contributing to this project as easy and tra
1212
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
1313
Report a bug by [opening a new issue]() with one of the available templates. It's that easy!
1414

15+
**NOTE: In order to offer sufficient and the best possible support, please read and follow the instructions below before submitting a ticket:**
16+
17+
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.
18+
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.**
19+
3) Try to make sure you have a working toolchain before starting to build.
20+
4) **Update to the _latest_ release version or maybe even use the `develop` branch.**
21+
5) Search for your problem in the available open issues, _before_ opening a new ticket.
22+
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.**
23+
7) Avoid to add new comments to closed issues unless they confirm a solution already available.
24+
8) Don't comment on tickets which do not specifically address your device or hardware - open a new ticket instead.
25+
9) Consider if you can help to solve other issues (e.g. you have the same hardware)
1526

1627
## Coding conventions
1728
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:

‎cmake/packaging/deb/changelog

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
stlink (1.7.0) unstable; urgency=medium
2+
3+
* Release v1.7.0
4+
5+
-- Nightwalker-87 <stlink-org> Sun, 25 Apr 2021 00:00:00 +0100
6+
17
stlink (1.6.1) unstable; urgency=medium
28

39
* Initial cpack-based package release for Debian/Ubuntu

‎cmake/packaging/rpm/changelog

+3
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
1+
* Sun Apr 25 2021 Nightwalker-87 <stlink-org> - 1.7.0
2+
- Release v1.7.0
3+
14
* Mon Jun 01 2020 Nightwalker-87 <stlink-org> - 1.6.1
25
- Initial cpack-based RPM package release

‎doc/release.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Release
33

44
This document describes the necessary steps for developers to create a release:
55

6-
1. Update `CHANGELOG.md`
6+
1. Update `CHANGELOG.md`, `cmake/packaging/deb/changelog` & `cmake/packaging/rpm/changelog`
77
2. Update `.version` with semantic version: `x.x.x`
88
3. Update `README.md` with semantic version `x.x.x` in commits badge
99
4. Create and push git tag and commits `git tag x.x.x`

0 commit comments

Comments
 (0)