You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: .github/CONTRIBUTING.md
+43-24
Original file line number
Diff line number
Diff line change
@@ -31,22 +31,25 @@ Stuff is a bit scattered, so this is where to look up.
31
31
1. Please create a fork at github
32
32
- See this [guide](https://www.dataschool.io/how-to-contribute-on-github/) for setting up and using a fork
33
33
- If allready forked, pull the recent state, or get most recent version otherwise.
34
-
0. On top of _FoxBin2Prg.prg_ there are two version numbers:
34
+
2. On top of _FoxBin2Prg.prg_ there are two version numbers:
35
35
`#DEFINE DN_FB2PRG_VERSION 1.19`
36
36
`#DEFINE DC_FB2PRG_VERSION_REAL '1.19.60'`
37
-
1. Please set the **minor** part of _DC_FB2PRG_VERSION_REAL_ to a new number.
37
+
3. Please set the **minor** part of _DC_FB2PRG_VERSION_REAL_ to a new number.
38
38
**Do not** alter the **1.19** part. This is written to the text files.
39
39
Alteration might force that the files must be newly commited, what is not everybodies taste.
40
-
3. Add a meaningfull description of the change in the changes list on top of _FoxBin2Prg.prg_.
40
+
4. Add a meaningfull description of the change in the changes list on top of _FoxBin2Prg.prg_.
41
41
The most recent entries for changes in the middle of this section around _* </HISTORIAL DE CAMBIOS Y NOTAS IMPORTANTES>_,
42
42
The most recent bugs are listed above _* </TESTEO Y REPORTE DE BUGS (AGRADECIMIENTOS)>_
43
-
4. Alter version in _README.md_
44
-
4. Add a description to _docs\ChangeLog.md_
45
-
6. Please alter the footer of *.md files touched to recent date.
46
-
4. If a change to the config files is made please add the description to the various properties (multi lang)
43
+
5. Alter version in _README.md_
44
+
6. Add a description to _docs\ChangeLog.md_
45
+
7. If a change to the config files is made please add the description to the various properties (multi lang)
47
46
-_C_FOXBIN2PRG_SYNTAX_INFO_EXAMPLE_LOC_cfg:_ for general settings
48
47
-_C_FOXBIN2PRG_SYNTAX_INFO_EXAMPLE_LOC_tab_cfg:_ for settings per table
49
-
4. Create a template _foxbin2prg.cfg.txt_ for general settings or _foxbin2prg.dbf.cfg.txt_ for the settings per table.
48
+
8. If a change to the parameters is made, change _C_FOXBIN2PRG_SYNTAX_INFO_EXAMPLE_LOC_ properties.
49
+
9. For changed functionality, add descriptive text on the appropriate _.md_ file in _docs_ folder.
50
+
10. Please alter the footer of \*.md files touched to recent date.
51
+
11.**The follwing steps are not neccesary, if you use *VPXDeployment* to create a new version that is applicable for Thor use.**
52
+
12. Create a template _foxbin2prg.cfg.txt_ for general settings or _foxbin2prg.dbf.cfg.txt_ for the settings per table.
50
53
- Do this even if no change to the setting to change the version number inside this files.
51
54
- Or change version number in those files manually
52
55
-**Note**. If you are not on an English comp, set the value _Language: EN_ in your local _foxbin2prg.cfg_ to create English files.
@@ -56,30 +59,46 @@ Stuff is a bit scattered, so this is where to look up.
56
59
DO FoxBin2Prg.prg WITH "-c","foxbin2prg.cfg.txt"
57
60
DO FoxBin2Prg.prg WITH "-t","foxbin2prg.dbc.txt"
58
61
```
59
-
5. If a change to the parameters is made, change _C_FOXBIN2PRG_SYNTAX_INFO_EXAMPLE_LOC_ properties.
60
-
4. For changed functionality, add descriptive text on the appropriate _.md_ file in _docs_ folder.
61
-
2. Alter the version number for the EXE to the version used above.
62
-
0. Compile to EXE **in VFP9 SP2**
63
-
8. Change Thor ([see below](#thor-conventions))
64
-
8. commit
65
-
9. push to your fork
66
-
0. create a pull request
67
-
1.
62
+
13. Alter the version number for the EXE to the version used above.
63
+
14. Compile to EXE **in VFP9 SP2**
64
+
15. Change Thor ([see below](#thor-conventions))
65
+
16. commit
66
+
17. push to your fork
67
+
18. create a pull request
68
68
69
69
## Thor conventions
70
70
This project is part of [VFPX](https://vfpx.github.io/) and published via [Thor](https://github.com/VFPX/Thor).
71
+
Some steps must be done to create the information for Thor
72
+
### Using VFPXDeployment
73
+
The standard procedure to create the Thor files is runing VFPXDeployment via Thor.
74
+
1. If you add or remove files to FoxBin2Prg, that you need in the release:
75
+
- alter *BuildProcess/installedfiles.txt*, see [here](https://github.com/VFPX/VFPXDeployment/blob/main/docs/Documentation.md#installedfilestxt)
76
+
- open the *Helper/Clean_ThorFolder.prg* file
77
+
- navigate to *Get_CompareFiles procedure*
78
+
- alter the TEXT .. ENDTEXT section to remove all files deleted and add new files, check the block for examples.
79
+
- There is a programm *Helper/GetRevisions.prg* to create the list, but this need to run VFPXDeployment one time to create the INSTALLEDFILES directory before.
80
+
2. Run VFPXDeployment. It will set version number to EXE, compile, set several documentation and create the files for Thor.
81
+
3. commit
82
+
4. push to your fork
83
+
5. create a pull request
84
+
85
+
### Without VFPXDeployment
86
+
If you do not use VFPXDeployment
71
87
There are some considerations to make to add a new version to Thor.
0 commit comments