Fixing Bugs & Adding Features
Editing the Docs
If you find typos, grammatical errors, logical errors, or simply wish to add or change the wording of a page, you can do so! At the bottom of each page, there is an "Edit this page" link which takes you to the page location on GitHub. Make changes to the files, and submit a Pull Request. If your changes are helpful, it will be merged and deployed.
Think of these docs like a Wikipedia page where viewers are free to edit pages without heavy oversight. This approach encourages new features to be documented easily and errors to be fixed quickly.
Reporting Issues
If you find issues with a piece of code in the GitHub repository, do one of the following:
-
Create a new issue on the GitHub page (link at the top right of this docs site, at least on desktop...). Make sure to describe the issue and the file(s) affected to the best of your knowledge.
-
Create a Pull Request with the code changes added. Someone will review your pull request and merge to the main branch if everything looks ok.
Adding New Features
A new feature will only be added to the OARBot repository if the following is true:
- The feature should always be active on the intended OARBot device(s). For example, a specific RO2 node needs to be launched at startup on the helper laptops
- The feature is intended to be publicly available (not just for an individual project)
- The new feature is general-purpose
If a new feature meets these requirements, submit a Pull Request with your edited code.