Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Common Model Library accepts new models and updates to existing models from NASA
simulation-developing groups and any other groups to whom CML provides value. Before
submitting changes, please look at our [coding standards](docs/CML_Coding_Standards.pdf)
submitting changes, please look at our [coding standards](docs/CML_Coding_Standards.rst)
in the `docs` folder. If you're using an older version of CML, please also double check
that the changes you're proposing have not already been integrated into CML in a more
recent release.
Expand Down Expand Up @@ -58,7 +58,7 @@ When submitting a new model to CML, you must provide:

Models must meet NPR 7150.2 Class A, B, C, or D to be accepted into CML. Additionally,
all new models must have unit tests which cover at least 90% of source code lines and
must be submitted alongside documentation which adequately describes the model. See the [coding standards](docs/CML_Coding_Standards.pdf) for more information.
must be submitted alongside documentation which adequately describes the model. See the [coding standards](docs/CML_Coding_Standards.rst) for more information.

Models must also provide sufficient value to CML to be accepted. Trivial models which
contain only a handful of lines of code can add a large maintenance burden to the CML team
Expand Down Expand Up @@ -111,4 +111,4 @@ You may use AI tools when contributing to CML, subject to the following guidelin

Before marking a pull request as ready for review, please ensure that any AI-generated
code, documentation, and tests adhere to our contribution guidelines and coding
standards.
standards.
3 changes: 0 additions & 3 deletions docs/CML_Coding_Standards.docx

This file was deleted.

Binary file removed docs/CML_Coding_Standards.pdf
Binary file not shown.
545 changes: 545 additions & 0 deletions docs/CML_Coding_Standards.rst

Large diffs are not rendered by default.

Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed models/dynamics/mass/dynamic_mass/docs/dynamic_mass.pdf
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed models/dynamics/state_descriptors/range/docs/range.pdf
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed models/environment/atmos/atmos_exec/docs/atmos_exec.pdf
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed models/environment/atmos/gust/docs/gust.pdf
Binary file not shown.
Binary file removed models/environment/atmos/gust/docs/gust_VV.pdf
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed models/fhw/effectors/springs/docs/springs.pdf
Binary file not shown.
Binary file removed models/fhw/effectors/vent/docs/vent.pdf
Binary file not shown.
Binary file removed models/fhw/effectors/vent/docs/vent_presentation.pdf
Binary file not shown.
Binary file removed models/interactions/aero/docs/aero.pdf
Binary file not shown.
Binary file not shown.
Binary file removed models/tools/unit_test/models/docs/unit_test.pdf
Binary file not shown.
Binary file removed models/utilities/bin_counter/docs/bin_counter.pdf
Binary file not shown.
Binary file not shown.
Binary file removed models/utilities/buffers/docs/buffers.pdf
Binary file not shown.
Binary file removed models/utilities/cml_message/docs/cml_message_VV.pdf
Binary file not shown.
Binary file removed models/utilities/color_string/docs/color_string.pdf
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed models/utilities/subscriptions/docs/subscriptions.pdf
Binary file not shown.
Binary file not shown.
Binary file removed models/utilities/trick_logging/docs/trick_logging.pdf
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading