Skip to content

docs: clarify bug reporting issue routing #20

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.

Sign up for GitHub

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

Closed
logan-scully-arm wants to merge 1 commit into from
Closed

docs: clarify bug reporting issue routing #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,16 @@ for details of how to create a pull request.
Contributions must go through code review on GitHub. Only reviewed contributions
can go to the main branch of MLIA.

### Reporting bugs

Report bugs by creating GitHub issues. Use the
[`arm/mlia` issue tracker](https://github.com/arm/mlia/issues) by default,
especially when the ownership is unclear or the problem spans multiple MLIA
repos.

Only file an issue in a plugin repository when the bug is obviously and
specifically confined to that plugin.

## Developer Certificate of Origin (DCO)

Before the MLIA project accepts your contribution, you need to certify its
Expand Down
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ available in the environment.
- [Plugin model](#plugin-model)
- [Quick start](#quick-start)
- [Python API](#python-api)
- [Reporting bugs](#reporting-bugs)
- [Development](#development)

## Inclusive language commitment
Expand Down Expand Up @@ -160,6 +161,15 @@ The Python API follows the same plugin-based architecture as the CLI: the core
package provides the entry points and shared output structure, while installed
plugins extend what targets and backends are available.

## Reporting bugs

Report bugs by creating a GitHub issue. Use the
[`arm/mlia` issue tracker](https://github.com/arm/mlia/issues) by default,
including when you are not sure which repo owns the problem.

Only file an issue in a plugin repository if the bug is clearly and
specifically isolated to that plugin.

## Development

Install `uv`, then sync dependencies for local development:
Expand Down
Loading