... | ... | @@ -13,13 +13,13 @@ This documentation should be your first stop when learning how to use Autoware, |
|
|
|
|
|
## Wiki pages
|
|
|
|
|
|
The [Autoware wiki](https://github.com/CPFL/Autoware/wiki) provides information mainly on contributing to Autoware, including developer guidelines.
|
|
|
The [Autoware wiki](https://gitlab.com/autowarefoundation/autoware.ai/autoware/wikis/home) provides information mainly on contributing to Autoware, including developer guidelines.
|
|
|
If you are interested in contributing a bug fix, a new feature, or an entire new module to Autoware, stop by the wiki first and check the Developer's Guide.
|
|
|
Complying with the Developer's Guide will ensure that your pull request gets merged faster.
|
|
|
|
|
|
Note: We are aware that the wiki documentation and the ReadTheDocs documentation are incomplete.
|
|
|
Correcting this is a priority of the releases to be done in 2019.
|
|
|
If you are willing to write documentation, please sign into GitHub and begin contributing.
|
|
|
If you are willing to write documentation, please sign into GitLab and begin contributing.
|
|
|
All contributions are welcome!
|
|
|
As with any open source project, Autoware is improved as much by its users as by its developers.
|
|
|
|
... | ... | @@ -40,7 +40,7 @@ Please provide **as much as possible** of the following information. |
|
|
The more information you provide, the sooner you will get a useful response.
|
|
|
|
|
|
- Post the complete output for error messages, starting from the command that you ran.
|
|
|
If the output is long, use a service such as [GitHubGists](https://gist.github.com/) and link that from your post.
|
|
|
If the output is long, use a service such as [GitLab Snippets](https://docs.gitlab.com/ee/user/snippets.html) or [GitHub Gists](https://gist.github.com/) and link that from your post.
|
|
|
Copy the text using copy-and-paste, do not re-type it by hand.
|
|
|
- Do not post screenshots of text.
|
|
|
Post the text itself.
|
... | ... | @@ -81,15 +81,15 @@ If you are trying to solve a problem, please use the [ROS Answers](#ros-answers) |
|
|
|
|
|
# Bug reports
|
|
|
|
|
|
If your problem is actually a bug in Autoware, then the [issue tracker](https://github.com/cpfl) for the relevant repository should be your next port of call.
|
|
|
If you do not know which repository is relevant (although hopefully discussion of your problem on the Discourse discussion board has identified that), then post an issue on the [general Autoware repository](https://github.com/CPFL/Autoware) and a developer will help you shift it to the correct place.
|
|
|
If your problem is actually a bug in Autoware, then the issue tracker for the relevant repository should be your next port of call.
|
|
|
If you do not know which repository is relevant (although hopefully discussion of your problem on the Discourse discussion board has identified that), then post an issue on the [general Autoware repository](https://gitlab.com/autowarefoundation/autoware.ai/autoware/issues) and a developer will help you shift it to the correct place.
|
|
|
|
|
|
When posting a bug report, it is important to be as detailed and accurate as possible.
|
|
|
The bug report template will help you fill in the necessary information, but in general all the same advice that applies to the Discourse discussion board also applies to filing a bug report.
|
|
|
You should also post a debug trace if possible, to identify where in the source code the problem occurs.
|
|
|
|
|
|
When giving your bug report a title, do *not* include something in the title that indicates it is a bug report, such as starting the title with `[Bug]` or `Bug report:`.
|
|
|
Instead, use [the `Bug` issue label](https://github.com/CPFL/Autoware/wiki/Contributing-to-Autoware.AI#issue-labels) to indicate that it is a bug report.
|
|
|
Instead, use [the `Bug` issue label](Contributing-to-Autoware.AI#issue-labels) to indicate that it is a bug report.
|
|
|
|
|
|
*Do not post requests for help on the issue trackers.*
|
|
|
They will be closed and you will be directed to the correct place to ask, slowing down the process of you getting help.
|
... | ... | @@ -104,7 +104,7 @@ When making a feature request, it helps to know as much about what you want. |
|
|
A feature request along the lines of "I want it to turn left more" will likely be ignored, but a feature request that begins "Handle multi-lane roundabouts in countries that drive on the left..." and provides detailed use cases is likely to attract attention.
|
|
|
|
|
|
When giving your feature request a title, do *not* include something in the title that indicates it is a feature request, such as starting the title with `[Feature]` or `Feature request:`.
|
|
|
Instead, use [the `Enhancement` issue label](https://github.com/CPFL/Autoware/wiki/Contributing-to-Autoware.AI#issue-labels) to indicate that it is a bug report.
|
|
|
Instead, use [the `Enhancement` issue label](Contributing-to-Autoware.AI#issue-labels) to indicate that it is a bug report.
|
|
|
|
|
|
|
|
|
# General ROS-related support
|
... | ... | |