Skip to content

Commit 15914d9

Browse files
[Downstream Change] Improved wording on issue reporting in the contribution guide (#307)
Softened the wording of when to raise issues in LLVM/picolibc vs arm-toolchain ATfE and ATfL readme now signposts to the detailed information in CONTRIBUTING.md.
1 parent 71a9825 commit 15914d9

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,15 @@ For guidance on how to contribute to the upstream projects see:
3636

3737
### Report an issue
3838

39-
Please make sure that the issue is specific to the *arm-toolchain*
40-
before reporting. If the issue exists in *llvm-project* or *picolibc*
41-
then please report the issue in the upstream project.
39+
Arm Toolchain is heavily dependent on the *llvm* and *picolibc* projects. If you have an issue that is generic to one of these projects, you may want to submit it directly:
40+
* [LLVM issue tracker](https://github.com/llvm/llvm-project/issues)
41+
* [Picolibc issue tracker](https://github.com/picolibc/picolibc/issues)
4242

43-
Please create a GitHub issue in the *arm-toolchain* project
44-
[Issues](https://github.com/arm/arm-toolchain/issues)
45-
list.
43+
This will allow you to interact directly with this community, including Arm's development team.
44+
45+
If the issue is in Arm Toolchain itself, or if you are not sure, please create a GitHub issue in the *arm-toolchain* project:
46+
* [Arm Toolchain issue tracker](https://github.com/arm/arm-toolchain/issues)
47+
* Please add the `ATfE` label for Arm Toolchain for Embedded issues, or `ATfL` for Arm Toolchain for Linux.
4648

4749
### Submit a fix
4850

arm-software/embedded/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -204,8 +204,7 @@ guide for detailed instructions.
204204

205205
## Providing feedback and reporting issues
206206

207-
Please raise an issue via [GitHub issues](https://github.com/arm/arm-toolchain/issues)
208-
and add the `ATfE` label if it is specific to the Arm Toolchain for Embedded.
207+
Please see the [Contribution Guide](../../CONTRIBUTING.md#report-an-issue) for guidance on how to report an issue or raise a feature request.
209208

210209
## Contributions and Pull Requests
211210

arm-software/linux/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -306,8 +306,7 @@ $ chrpath -l ./example
306306

307307
## Providing feedback and reporting issues
308308

309-
Please raise an issue via [GitHub issues](https://github.com/arm/arm-toolchain/issues)
310-
and add the `ATfL` label if it is specific to the Arm Toolchain for Linux.
309+
Please see the [Contribution Guide](../../CONTRIBUTING.md#report-an-issue) for guidance on how to report an issue or raise a feature request.
311310

312311
## Contributions and Pull Requests
313312

0 commit comments

Comments
 (0)