-
Notifications
You must be signed in to change notification settings - Fork 35
Add feedback sections to the docs #304
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Add Quick Links section (including ways to provide feedback) to the main README. Add feedback and contribution sections at the end of Linux toolchain README. Change-Id: I0aea207b3365456c13b92e33ecfd4c5d845e7d49
LGTM |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @voltur01. Couple of comments.
arm-software/linux/README.md
Outdated
|
||
## Providing feedback and reporting issues | ||
|
||
Please raise an issue via [Github issues](https://github.com/arm/arm-toolchain/issues). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we want users to prefix [ATFL] for ATfL issues?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have labels https://github.com/arm/arm-toolchain/labels for ATfE and ATfL.
I would not require it to be set, but I can add a hint both here and in ATfE version of README.
Also, Arm Toolchain variant was added to the "bug" issue template #305 to help clarify.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added
Fix path to CONTRBUTING.md and refer to ATfE/ATfL labels. Change-Id: I0c2c6ab1c12b768431a05a0473ca4634c0ed9372
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LG. Thanks @voltur01 for the changes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is OK in the ATfL part. Do we really need to modify the top-level README file? It's LLVM's...
Approving tentatively.
The top-level README is our own https://github.com/arm/arm-toolchain/blob/arm-software/README.md - very minimal one, so I thought that it would be useful to add some links, instead of expecting people to click through |
Ah yes, now I see that the milk has been spilled already and we replaced the contents of this file entirely. Thus I'm OK with the change discussed here. |
Add Quick Links section (including ways to provide feedback) to the main README.
Add feedback and contribution sections at the end of Linux toolchain README.