search

VSoftTechnologies / Delphi-Mocks

A Open Source Mocking framework for Delphi XE2 or later
Apache License 2.0
229 stars 108 forks source link

[discussion] Delphi Mock documentation #123

Open bogdanpolak opened 4 years ago

bogdanpolak commented 4 years ago

I'd like to make some contribution to Delphi Mock - I think that docs could be a little more expanded. Any feedback on that?

vincentparrett commented 4 years ago

I'd certainly welcome contributions. For doco, just go for it and submit a PR. For code changes, please create an issue so we can provide feeback before you make the PR, that way there is more chance of it being accepted. Make code PR's as small as possible, large changes which affect lots of files are difficult to review and validate.

bogdanpolak commented 4 years ago

Cool! I can focus on docs for now. Can start next week, I'm in process of releasing 1.7 version of my own GitHub project and and when it will be done can jump to Delphi Mock.

Connected question with doc visibility: It would be nice to organise folder structure of the project to allow main REDME.md be visible even without scrolling of Code tab. Good practices for project folder structure are folders:

- [docs]
- [examples]
- [packages]
- [src]
- [tests]
README.md
.gitignore
.gitmodules
LICENSE.txt

other files should be in subfolders. What do you think about this project structure?

vincentparrett commented 4 years ago

I will re-org the folders, been planning to do that for a while. Only issue is that it will break people's projects but that can't be avoided (and can be fixed by using dpm when it's ready).

bogdanpolak commented 4 years ago

Which Delphi version in currently supported? XE2?

vincentparrett commented 4 years ago

XE2 or later.

bogdanpolak commented 4 years ago

@vincentparrett: Can you look on this sample? https://github.com/bogdanpolak/Delphi-Mocks I want to add code sample bellow - this portion is more like introduction

Laurensvanrun commented 2 years ago

@bogdanpolak: can you create a pull request for your updated documentation? I think that all updates are welcome :-)