-
Notifications
You must be signed in to change notification settings - Fork 0
/
contribution.txt
34 lines (19 loc) · 1.69 KB
/
contribution.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
You are very welcome to contribute to this tool! All you need to do to make your contribution on to the tool as a non development team member is the following:
1. git clone https://github.com/quantsareus/reprod<...>.git
2. cd reprod<...>
3. Make your edits.
4. git add --all
5. git commit -m '<description of your fabulous update>'
6. git push origin <name_of_your_fork_branch>
However, before you can do step 6, you need to register on github.com, once.
If you are not familiar with the collab development tool 'git' already, search for the free ProGit_2020.pdf book (or a newer version) on duckduckgo.com. The book explains almost everything perfectly.
Alternatively, it should also be possible to create a fork using the guthub web interface. In case request duckduckgo.com, how to perform that.
Your improved version has to meet four little requirements to get accepted to be incorporated into the main line version:
1. You have to provide a working version, that can be tried out.
2. The update version can still be distributed as a single file.
3. The update version does not contain a GUI element.
4. An update version usually contains the features of the current version.
Other than these few requirements will - from the author's point of view - unnecessarily complicate the tiny tool. The last requirement, however, might be discussed, when offerering a significant improvement of the tool, that's ready to use.
Your accepted fork currently gets merged into the main branch once a month, when I take my research days.
Additionally, the author also provides his personal '# Further development options' at the end of the script file
In order to get a scrollable view let ' | less' follow the command.