Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[discussion] Delphi Mock documentation #123

Open
bogdanpolak opened this issue Feb 19, 2020 · 7 comments
Open

[discussion] Delphi Mock documentation #123

bogdanpolak opened this issue Feb 19, 2020 · 7 comments

Comments

@bogdanpolak
Copy link

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
Copy link
Member

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
Copy link
Author

bogdanpolak commented Feb 19, 2020

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
Copy link
Member

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
Copy link
Author

Which Delphi version in currently supported? XE2?

@vincentparrett
Copy link
Member

XE2 or later.

@bogdanpolak
Copy link
Author

@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
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants