Update Contributing to Gryphon authored by Allen, Bruce (CIV)'s avatar Allen, Bruce (CIV)
Everyone is encouraged to contribute to Gryphon! Everyone is encouraged to contribute to Gryphon!
# Bug reports # Reporting Bugs
For bug reports, please see [Reporting Bugs](Reporting-Bugs). Please report any Gryphon bugs by email or by submitting an issue. To submit an issue go to https://gitlab.nps.edu/monterey-phoenix/user-interfaces/gryphon/-/issues and click the blue "New issue" button. When reporting bugs please include this information:
# Clarifications, improvements, and features * The Gryphon version
* The .mp code that generates this error
* The diagnostics text that Gryphon prints in the command window
* Screenshots, if applicable
# Requesting Clarifications, improvements, and features
If you would like to suggest improvements and new capabilities for Gryphon please submit an issue. Go to https://gitlab.nps.edu/monterey-phoenix/user-interfaces/gryphon/-/issues and click the blue "New issue" button. Please provide: If you would like to suggest improvements and new capabilities for Gryphon please submit an issue. Go to https://gitlab.nps.edu/monterey-phoenix/user-interfaces/gryphon/-/issues and click the blue "New issue" button. Please provide:
* Title. * Title.
...@@ -14,12 +19,12 @@ If you would like to suggest improvements and new capabilities for Gryphon pleas ...@@ -14,12 +19,12 @@ If you would like to suggest improvements and new capabilities for Gryphon pleas
You can test the Gryphon GUI by interacting with the various controls in the menus, the code editor, and the main window. You can test the Gryphon GUI by interacting with the various controls in the menus, the code editor, and the main window.
# Automated testing # Automated testing
Automated testing is available for testing .mp files, the trace generator, and core Gryphon components. For automated testing, run `test.py [-p <path to models>] [-i <index>] [-s <scope>]`. For example: In environments where source code is distributed, automated testing is available for testing .mp files, the trace generator, and core Gryphon components. For automated testing, run `test.py [-p <path to models>] [-i <index>] [-s <scope>]` at a command prompt. For example:
cd ~/mp_gryphon/gryphon/python cd ~/mp_gryphon/gryphon/python
./test.py ./test.py
The optional parameters are: Optional parameters are:
* `-p <path to models>` - A directory containing .mp models to test with, default `../../preloaded-examples/models`. * `-p <path to models>` - A directory containing .mp models to test with, default `../../preloaded-examples/models`.
* `-i <index>` - Use this option to test just the .mp model at this index. * `-i <index>` - Use this option to test just the .mp model at this index.
... ...
......