diff options
| author | Y. Wang <yw05@forksworld.de> | 2022-08-12 08:29:35 +0200 |
|---|---|---|
| committer | Y. Wang <yw05@forksworld.de> | 2022-08-12 08:29:35 +0200 |
| commit | 08daa87fce78e1f3c68bdf8cb8a6083fb57ef578 (patch) | |
| tree | cde03809250a5303a5fa73e3f47fb9d950a325be /assets/manual/tex | |
| parent | 2d2f3dd466ef8c3b3af40074e8991de36be60407 (diff) | |
| download | advtrains-08daa87fce78e1f3c68bdf8cb8a6083fb57ef578.tar.gz advtrains-08daa87fce78e1f3c68bdf8cb8a6083fb57ef578.tar.bz2 advtrains-08daa87fce78e1f3c68bdf8cb8a6083fb57ef578.zip | |
Mention busted and mineunit as tools for unittesting
Diffstat (limited to 'assets/manual/tex')
| -rw-r--r-- | assets/manual/tex/contributing.tex | 3 |
1 files changed, 1 insertions, 2 deletions
diff --git a/assets/manual/tex/contributing.tex b/assets/manual/tex/contributing.tex index 9b7d53b..a4a3ac2 100644 --- a/assets/manual/tex/contributing.tex +++ b/assets/manual/tex/contributing.tex @@ -1,12 +1,11 @@ \part{Contributor Guide} -\section{Recommendations} At the time of writing, \advtrains{} uses a mostly email-based workflow. It is therefore recommended to format patches with \texttt{git-format-patch} and send them with \texttt{git-send-email}. Alternatively, if you are unable to send patches via email, you can also post patches onto the forum thread. When sending patches, please include binary files as well instead of linking those to external sources. \section{Code changes} -Please include methods of automated testing if possible. +\advtrains{} uses \texttt{busted}\footnote{\url{https://olivinelabs.com/busted/}} and \texttt{mineunit}\footnote{\url{https://github.com/S-S-X/mineunit}} for unittesting. Please include unittests along with your changes if possible. If you want to make significant changes to \advtrains{}, it is recommended to first discuss your proposal with the developers or, at least, with people who have sufficient knowledge of the part of \advtrains{} that you want to work on. |