romfast/foxbin2prg
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
bc174a5c4980816819356ebd25e37627872afd84
foxbin2prg/.github/CONTRIBUTING.md
Lutz 57ad20f9e8 Work for VFPXDeployment
2023-08-07 14:59:54 +02:00

4.7 KiB
Raw Blame History

How to contribute to FoxBin2Prg

Bug report?

  • Please check issues if the bug is reported
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.
  • Please add your current configuration creating a config file via DO FOXBIN2PRG.PRG WITH '-C','path-to-source\FoxBin.cfg'. Do not include your normal config

Did you write a patch that fixes a bug?

  • Open a new GitHub merge request with the patch.
  • Ensure the PR description clearly describes the problem and solution.
    • Include the relevant version number if applicable.
  • See New version for additional tasks

Coding conventions

Start reading our code and you'll get the hang of it. We optimize for readability:

  • Beautification is done like:
    • Keywords: Mixed case
    • Symbols: First occurence
    • Indentation Tabs, 1
    • Indent anything then Comments
  • Please do not run BeautifyX with mDots insertion against the code.
  • We ALWAYS put spaces after list items and method parameters ([1, 2, 3], not [1,2,3]), around operators (x = 1, not x=1).
  • This is open source software. Consider the people who will read your code, and make it look nice for them. It's sort of like driving a car: Perhaps you love doing donuts when you're alone, but with passengers the goal is to make the ride as smooth as possible.
  • Please kindly add comments where and what you change

New version

Please note, there are some tasks to set up a new version. Stuff is a bit scattered, so this is where to look up.

  1. Please create a fork at github
    • See this guide for setting up and using a fork
    • If allready forked, pull the recent state, or get most recent version otherwise.
  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'
  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.
  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)>
  5. Alter version in README.md
  6. Add a description to docs\ChangeLog.md
  7. Please alter the footer of *.md files touched to recent date.
  8. 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
  9. 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.
    • run like:
    CD Path_Top_Project
DO FoxBin2Prg.prg WITH "-c","foxbin2prg.cfg.txt"
DO FoxBin2Prg.prg WITH "-t","foxbin2prg.dbc.txt"
  10. If a change to the parameters is made, change C_FOXBIN2PRG_SYNTAX_INFO_EXAMPLE_LOC properties.
  11. For changed functionality, add descriptive text on the appropriate .md file in docs folder.
  12. Alter the version number for the EXE to the version used above.
  13. Compile to EXE in VFP9 SP2
  14. Change Thor (see below)
  15. commit
  16. push to your fork
  17. create a pull request

Thor conventions

This project is part of VFPX and published via Thor.
There are some considerations to make to add a new version to Thor.
Please check Supporting Thor Updater 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

Thanks

Last changed: 2023/08/06 Picture