v80.5
This commit is contained in:
67
.github/CONTRIBUTING.md
vendored
67
.github/CONTRIBUTING.md
vendored
@@ -31,22 +31,25 @@ Stuff is a bit scattered, so this is where to look up.
|
||||
1. Please create a fork at github
|
||||
- See this [guide](https://www.dataschool.io/how-to-contribute-on-github/) for setting up and using a fork
|
||||
- If allready forked, pull the recent state, or get most recent version otherwise.
|
||||
0. On top of _FoxBin2Prg.prg_ there are two version numbers:
|
||||
2. On top of _FoxBin2Prg.prg_ there are two version numbers:
|
||||
`#DEFINE DN_FB2PRG_VERSION 1.19`
|
||||
`#DEFINE DC_FB2PRG_VERSION_REAL '1.19.60'`
|
||||
1. Please set the **minor** part of _DC_FB2PRG_VERSION_REAL_ to a new number.
|
||||
3. Please set the **minor** part of _DC_FB2PRG_VERSION_REAL_ to a new number.
|
||||
**Do not** alter the **1.19** part. This is written to the text files.
|
||||
Alteration might force that the files must be newly commited, what is not everybodies taste.
|
||||
3. Add a meaningfull description of the change in the changes list on top of _FoxBin2Prg.prg_.
|
||||
4. Add a meaningfull description of the change in the changes list on top of _FoxBin2Prg.prg_.
|
||||
The most recent entries for changes in the middle of this section around _* </HISTORIAL DE CAMBIOS Y NOTAS IMPORTANTES>_,
|
||||
The most recent bugs are listed above _* </TESTEO Y REPORTE DE BUGS (AGRADECIMIENTOS)>_
|
||||
4. Alter version in _README.md_
|
||||
4. Add a description to _docs\ChangeLog.md_
|
||||
6. Please alter the footer of *.md files touched to recent date.
|
||||
4. If a change to the config files is made please add the description to the various properties (multi lang)
|
||||
5. Alter version in _README.md_
|
||||
6. Add a description to _docs\ChangeLog.md_
|
||||
7. If a change to the config files is made please add the description to the various properties (multi lang)
|
||||
- _C_FOXBIN2PRG_SYNTAX_INFO_EXAMPLE_LOC_cfg:_ for general settings
|
||||
- _C_FOXBIN2PRG_SYNTAX_INFO_EXAMPLE_LOC_tab_cfg:_ for settings per table
|
||||
4. Create a template _foxbin2prg.cfg.txt_ for general settings or _foxbin2prg.dbf.cfg.txt_ for the settings per table.
|
||||
8. If a change to the parameters is made, change _C_FOXBIN2PRG_SYNTAX_INFO_EXAMPLE_LOC_ properties.
|
||||
9. For changed functionality, add descriptive text on the appropriate _.md_ file in _docs_ folder.
|
||||
10. Please alter the footer of \*.md files touched to recent date.
|
||||
11. **The follwing steps are not neccesary, if you use *VPXDeployment* to create a new version that is applicable for Thor use.**
|
||||
12. Create a template _foxbin2prg.cfg.txt_ for general settings or _foxbin2prg.dbf.cfg.txt_ for the settings per table.
|
||||
- Do this even if no change to the setting to change the version number inside this files.
|
||||
- Or change version number in those files manually
|
||||
- **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.
|
||||
DO FoxBin2Prg.prg WITH "-c","foxbin2prg.cfg.txt"
|
||||
DO FoxBin2Prg.prg WITH "-t","foxbin2prg.dbc.txt"
|
||||
```
|
||||
5. If a change to the parameters is made, change _C_FOXBIN2PRG_SYNTAX_INFO_EXAMPLE_LOC_ properties.
|
||||
4. For changed functionality, add descriptive text on the appropriate _.md_ file in _docs_ folder.
|
||||
2. Alter the version number for the EXE to the version used above.
|
||||
0. Compile to EXE **in VFP9 SP2**
|
||||
8. Change Thor ([see below](#thor-conventions))
|
||||
8. commit
|
||||
9. push to your fork
|
||||
0. create a pull request
|
||||
1.
|
||||
13. Alter the version number for the EXE to the version used above.
|
||||
14. Compile to EXE **in VFP9 SP2**
|
||||
15. Change Thor ([see below](#thor-conventions))
|
||||
16. commit
|
||||
17. push to your fork
|
||||
18. create a pull request
|
||||
|
||||
## Thor conventions
|
||||
This project is part of [VFPX](https://vfpx.github.io/) and published via [Thor](https://github.com/VFPX/Thor).
|
||||
Some steps must be done to create the information for Thor
|
||||
### Using VFPXDeployment
|
||||
The standard procedure to create the Thor files is runing VFPXDeployment via Thor.
|
||||
1. If you add or remove files to FoxBin2Prg, that you need in the release:
|
||||
- alter *BuildProcess/installedfiles.txt*, see [here](https://github.com/VFPX/VFPXDeployment/blob/main/docs/Documentation.md#installedfilestxt)
|
||||
- open the *Helper/Clean_ThorFolder.prg* file
|
||||
- navigate to *Get_CompareFiles procedure*
|
||||
- alter the TEXT .. ENDTEXT section to remove all files deleted and add new files, check the block for examples.
|
||||
- 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.
|
||||
2. Run VFPXDeployment. It will set version number to EXE, compile, set several documentation and create the files for Thor.
|
||||
3. commit
|
||||
4. push to your fork
|
||||
5. create a pull request
|
||||
|
||||
### Without VFPXDeployment
|
||||
If you do not use VFPXDeployment
|
||||
There are some considerations to make to add a new version to Thor.
|
||||
Please check [Supporting Thor Updater](https://vfpx.github.io/thorupdate/)
|
||||
In special:
|
||||
- Update _Project.txt_, in special the version number
|
||||
- and run the script included, or
|
||||
- add files to _FoxBin2Prg.zip_, namely
|
||||
- FoxBin2Prg.prg,
|
||||
- FoxBin2Prg.exe,
|
||||
- the config files templates
|
||||
- Update the version number in _FoxBin2PrgVersion.txt_
|
||||
- update the *Helper/Clean_ThorFolder.prg* file, see above
|
||||
- add files to _FoxBin2Prg.zip_, namely
|
||||
- FoxBin2Prg.prg,
|
||||
- FoxBin2Prg.exe,
|
||||
- the config files templates
|
||||
- Clean_ThorFolder.prg
|
||||
- Update the version number in _FoxBin2PrgVersion.txt_
|
||||
- Update the changelog in _FoxBin2PrgVersion.txt_
|
||||
- the use of CreateThorUpdate.ps1 is not longer recommended.
|
||||
|
||||
Thanks
|
||||
|
||||
----
|
||||
Last changed: _2023/08/06_ 
|
||||
Last changed: _2023/08/08_ 
|
||||
|
||||
Reference in New Issue
Block a user