Filing issues is a great way to contribute to the Fuchsia project. You can file an issue using Issue Tracker, Google’s issue tracking tool for open source projects.
When to file an issue
Issue Tracker issues are used to track and suggest the following types of changes:
- Minor changes or suggestions to Fuchsia's code and documentation.
- Reporting security issues
- Proposing open source third-party code to be included in Fuchsia
For proposing code changes that would affect Fuchsia significantly, see Propose significant code changes.
As an open source contributor, you can file a issue with the following templates:
Template | Purpose |
Fuchsia Default | Alert the Fuchsia team that there is a bug related to using or building Fuchsia. |
Fuchsia Security external bug report | Report a security issue related to Fuchsia. |
Fuchsia.dev Documentation | Alert the Documentation team that there is an issue related to fuchsia.dev. |
Open Source Review Board | Propose open source external code to be included in Fuchsia. Review the Open Source Review Board (OSRB) process before filing an issue with the Open Source Review Board (OSRB). |
Report Community Abuse | Alert Community Managers about any violations of the Code of Conduct that you may have experienced in the Fuchsia community. |
How to file an issue
To file an issue in Fuchsia, do the following:
- Go to https://issues.fuchsia.dev.
- Click Create Issue.
- Select one of the following components from the Component dropdown:
- For Fuchsia Default template, select Fuchsia
- For Fuchsia Security bug report template, select Fuchsia > Security > Vulns
- For Fuchsia.dev Documentation template, select Fuchsia > Documentation
- For Open Source Review Board template, select Fuchsia > OSRB
- For Report Community Abuse template, select Fuchsia > Community
- Select the template from the Template dropdown if not already defaulted to above named template
- Complete the questions associated with the template you selected.
- Click Create.
Issue reporting guidelines
When you create an issue, include the following:
- A description of the issue that you’re experiencing, including the expected behavior.
- The steps necessary to reproduce the issue.
- (Optional) Screenshots
- (Optional) If a bug can be identified through a unit test, then create a simplified test and attach it to the issue.
Issue resolution
After you have filed an issue, a team of triagers will route your issue to the appropriate team. That team is responsible for prioritizing, assigning, and responding to your issue.
Propose significant code changes
There are some instances where filing an issue would not be the best course of action. Here are a few examples of alternative courses of action:
Scenario | Process |
Proposing a change that would significantly affect the Fuchsia API. | Create an API Design Document. For more information, see Fuchsia API Council Charter. |
Proposing a change that would affect a large part of the Fuchsia codebase or the technical direction of the Fuchsia project. | Propose a Request for Comments (RFC). For more information on RFCs, see Create an RFC. |