1 c75df689 2019-07-14 stsp Game of Trees (Got) is a version control system which prioritizes ease
2 c75df689 2019-07-14 stsp of use and simplicity over flexibility.
4 dd2a8a69 2019-07-14 stsp Got is being developed exclusively on OpenBSD. It is not a drop-in
5 dd2a8a69 2019-07-14 stsp replacement for other version control systems and it does not attempt
6 010a287c 2019-07-14 stsp to compete with anything else than the use of other version control
7 dd2a8a69 2019-07-14 stsp systems in the context of the OpenBSD project.
8 dd2a8a69 2019-07-14 stsp Got's target audience are OpenBSD developers, and its focus is directed
9 dd2a8a69 2019-07-14 stsp at the particular needs and use cases of the OpenBSD project.
11 7cc94e29 2018-09-08 stsp To compile the Got tool suite on OpenBSD, run:
15 7cc94e29 2018-09-08 stsp $ mkdir ~/bin
16 7cc94e29 2018-09-08 stsp $ make install
18 7cc94e29 2018-09-08 stsp This will install the following commands to ~/bin:
20 7cc94e29 2018-09-08 stsp got (command line interface)
21 7cc94e29 2018-09-08 stsp tog (ncurses interface)
22 7cc94e29 2018-09-08 stsp and several helper programs from the libexec directory
24 0e673013 2019-01-02 stsp Tests will pass only after 'make install' because they rely on installed
25 c4096499 2019-01-02 stsp binaries in $PATH. Tests in the cmdline directory currently depend on git(1).
27 c4096499 2019-01-02 stsp $ doas pkg_add git
28 7cc94e29 2018-09-08 stsp $ make regress
30 7cc94e29 2018-09-08 stsp Man pages are not installed yet but can be viewed with mandoc:
32 7cc94e29 2018-09-08 stsp $ mandoc got/got.1 | less
33 7cc94e29 2018-09-08 stsp $ mandoc got/git-repository.5 | less
34 804dc7b9 2019-03-26 stsp $ mandoc got/got-worktree.5 | less
35 7cc94e29 2018-09-08 stsp $ mandoc tog/tog.1 | less
38 42620da7 2019-07-14 stsp Guidelines for reporting problems:
40 42620da7 2019-07-14 stsp All problem/bug reports should include a reproduction recipe in form of a
41 42620da7 2019-07-14 stsp shell script which starts out with an empty repository and runs a series of
42 8deda1af 2019-07-14 stsp Got and/or Git commands to trigger the problem, be it a crash or some other
43 42620da7 2019-07-14 stsp undesirable behaviour.
45 42620da7 2019-07-14 stsp The regress/cmdline directory contains plenty of example scripts.
46 42620da7 2019-07-14 stsp An ideal reproduction recipe is written as an xfail ("expected failure")
47 42620da7 2019-07-14 stsp regression test. For a real-world example of an xfail test, see commits
48 42620da7 2019-07-14 stsp 4866d0842a2b34812818685aaa31d3e0a966412d and
49 8deda1af 2019-07-14 stsp 2b496619daecc1f25b1bc0c53e01685030dc2c74 in Got's history.
51 42620da7 2019-07-14 stsp Please take this request very seriously; Ask for help with writing your
52 42620da7 2019-07-14 stsp regression test before asking for your problem to be fixed. Time invested
53 42620da7 2019-07-14 stsp in writing a regression test saves time wasted on back-and-forth discussion
54 42620da7 2019-07-14 stsp about how the problem can be reproduced. A regression test will need to be
55 42620da7 2019-07-14 stsp written in any case to verify a fix and prevent the problem from resurfacing.
57 9532f6b4 2019-07-14 stsp It is also possible to write test cases in C. Various examples of this
58 9532f6b4 2019-07-14 stsp exist in the regress/ directory. Most such tests are unit tests written
59 8deda1af 2019-07-14 stsp before Got's command line interface was available; it is unlikely that a
60 9532f6b4 2019-07-14 stsp problem found during regular usage will require a test to be written in C.
62 42620da7 2019-07-14 stsp Some areas of code, such as the tog UI, are not covered by automated tests.
63 56f95bee 2019-07-14 stsp Please always try to find a way to trigger your problem via the command line
64 56f95bee 2019-07-14 stsp interface before reporting a problem without a written test case included.
65 56f95bee 2019-07-14 stsp If writing an automated test really turns out to be impossible, please
66 56f95bee 2019-07-14 stsp explain in very clear terms how the problem can be reproduced.
68 42620da7 2019-07-14 stsp Mail problem reports to: Stefan Sperling <stsp@stsp.name>
71 42620da7 2019-07-14 stsp Guidelines for submitting patches:
73 8deda1af 2019-07-14 stsp Please keep the intended target audience in mind when contributing to Got.
74 42620da7 2019-07-14 stsp Patches related to non-OpenBSD systems will not be integrated before an
75 8deda1af 2019-07-14 stsp official portable version of Got is being worked on, if ever.
77 42620da7 2019-07-14 stsp Please refrain from sending long series of patches without prior discussion.
79 42620da7 2019-07-14 stsp Mail patches to: Stefan Sperling <stsp@stsp.name>
81 42620da7 2019-07-14 stsp Pull requests via any Git hosting sites will likely be overlooked or ignored.
