maythamfahmi / CryptoNet

CryptoNet is simple, fast and a lightweight asymmetric and symmetric encryption library.
https://github.com/maythamfahmi/CryptoNet
MIT License
101 stars 19 forks source link

[feature request]: Add an Examples folder to the project hierarchy. #97

Closed jwdonahue closed 1 month ago

jwdonahue commented 1 month ago

Contact Details

joseph@sharperhacksllc.cm

Is your feature request related to a problem? Please describe.

V2 examples are embedded in the README.md file. I have found that good working examples, make excellent components for integration/acceptance testing, driven by unit tests.

Describe the solution you'd like

Describe alternatives you've considered

No response

Additional context

No response

Priority Level

Medium

Code of Conduct

jwdonahue commented 1 month ago

I have driven some development this way. Create a feature example project and unit test driver, for TDD and then I wind up with a descent example usage that I can point to in my docs (whenever I get around to those).

I am not a TDD purist though. I find it's helpful to have some code to test, when I start writing test code, even if it's just a do-nothing program.

jwdonahue commented 1 month ago

Draft PR: https://github.com/maythamfahmi/CryptoNet/pull/103/files

I have not removed CryptoNet.Cli yet. I still need to evaluate the coverage situation.

jwdonahue commented 1 month ago

Okay, I think this is ready for review: #103

maythamfahmi commented 1 month ago

Thanks, I am reviewing now, just have seen some files like CryptoNet.vtg, CryptoNet.vpwhist, CryptoNet.vpw, CryptoNet.vpj is those suppose to be part of the solution? maybe we need to add following to gitignore

Ignore SlickEdit files.

.vpj .vpw .vpwhist .vtg

Let me know what you think?

maythamfahmi commented 1 month ago

When this #97 solved, #87 and #88 will be not needed and can be close when this is merged to https://github.com/maythamfahmi/CryptoNet/tree/version3

jwdonahue commented 1 month ago

Yes! I forgot to add that to the .gitignore file, will fix shortly.

Those are SlickEdit project files. I often use a real programmer's editor along side of Visual Studio, especially when conflict resolutions get complicated.

jwdonahue commented 1 month ago

All comments resolved.

maythamfahmi commented 1 month ago

Part of #84