diff --git a/pub/dissertation/chapters/design.tex b/pub/dissertation/chapters/design.tex index 5d3a6f2..f4bd84a 100644 --- a/pub/dissertation/chapters/design.tex +++ b/pub/dissertation/chapters/design.tex @@ -428,7 +428,37 @@ Brief overview of what it is supposed to do... % TODO % - gitignore % - changing url for repo % - testing everything still worked +\begin{itemize} + \item Adding the Gradle build tools can be seen as being helpful + for others, as it would allow for the XPC library to be added + as a dependency, especially if the NASA Ames Research Center Diagnostics and Prognostics Group + were to add it to the GitHub repository, it would mean that it would be easier for + people to access Maven Packages for XPC + \item Therefore, to help improve the experience for other people who would want + to develop with the XPC Java library, it would be logical to submit a + pull request + \item But it did mean making sure that the contribution would be perfect and not contain problems % TODO Improve wording +\end{itemize} +\subsubsection{Testing} +\begin{itemize} + \item The XPC Java library includes a JUnit 4 test, however, implementing this + with Gradle proved useless, as it was not able to get the results from the + tests, which would be bad for not being able to catch problems with new builds + \item Therefore, the tests were updated to JUnit 5, where most of the changes were + adding asserts for throws~\cite{junit:migrate} + \footnote{The commit including the changes to the tests can be viewed here: + \url{https://github.com/smyalygames/XPlaneConnect/commit/e7b8d1e811999b4f8d7230f60ba94368e14f1148}} +\end{itemize} + +\subsubsection{GitHub} +\begin{itemize} + \item Made sure to add generated build files to .gitignore + \item Changed the URL of the repository in Gradle to NASA's repository so that + the Maven package can be published correctly on the GitHub repository + \item From the beginning anyways, made sure to have insightful commit messages + \item Submitted the pull request stating the changes made\footnote{\url{https://github.com/nasa/XPlaneConnect/pull/313}} +\end{itemize} diff --git a/pub/dissertation/dissertation.pdf b/pub/dissertation/dissertation.pdf index c067e4f..15d5a1f 100644 Binary files a/pub/dissertation/dissertation.pdf and b/pub/dissertation/dissertation.pdf differ diff --git a/pub/dissertation/dissertation.sum b/pub/dissertation/dissertation.sum index 8a30791..5caf80a 100644 --- a/pub/dissertation/dissertation.sum +++ b/pub/dissertation/dissertation.sum @@ -1 +1 @@ -2840 +3074 diff --git a/pub/dissertation/references.bib b/pub/dissertation/references.bib index 582813d..b5a80bf 100644 --- a/pub/dissertation/references.bib +++ b/pub/dissertation/references.bib @@ -350,3 +350,12 @@ urldate = {2024-05-13}, } +@online{junit:migrate, + author = {The JUnit Team}, + title = {JUnit 5 User Guide - Migrating from JUnit 4}, + url = { + https://github.com/smyalygames/XPlaneConnect/commit/e7b8d1e811999b4f8d7230f60ba94368e14f1148 + }, + urldate = {2024-05-15}, +} +