Your help is highly appreciated. Thank you!
You may help via:
- Commenting on the existing issues in the DryIoc GitHub repository.
- Opening new issues for bugs, enhancements, and feature proposals.
- Creating Pull Requests with the improvements, failed tests for the found bugs, and the bug-fixes.
- Correcting the documentation errors and submitting the new documentation topics.
- Asking and answering the questions on StackOverflow, tagging your questions with
dryioctag for easy finding. - Discussing the problems and ideas in the Gitter or Slack rooms.
- Poking me on Twitter.
If you found the problem with DryIoc:
- Please check that you are using the latest DryIoc version.
- Create new issue with problem description.
- To get faster feedback, faster fixes, and generally to make me happy :-)
- Fork DryIoc
- Add failing tests reproducing your case to
test\DryIoc.IssuesTestsproject. Check other files in the project for general guideline, but nothing is strict here. - Ignore the failing tests with
[Ignore("fixme")]attribute, so that CI build should pass. - Commit your tests and create a Pull Request for me to review.
Before sending the Pull Request please build the solution with the b.bat located in the root folder.
It will build all projects for in the Release configuration, will run unit tests and generate the documentation. Make sure that there are no project build errors or failing tests.
Open DryIoc.sln solution and re-build it. If something is failing you may try to close VS, run b.bat in the root folder, open VS and try to build again.
Productivity hint: I am using NCrunch extension for the MS Visual Studio to build and run the tests continuously and to get the immediate feedback, quickly find regressions, and generally experiment with the code.
DryIoc provides the friendly VSCode developing experience.
Basically you need just the C# extension installed.
Then you may run the build_with_packaging.bat from the shell to ensure packages are restored, code is built, tests are passing and packages are created.
You may go to the test projects in the test sub-folder and Run or Debug the tests via the editor lens provided by the extension.
- Edit the selected document .cs (not the .md) file in the docs\DryIoc.Docs sub-folder.
- Run the
build_the_docs.batfile from the root folder in the shell. - Check the updated .md file. You may preview the markdown files with the respective markdown extension in VSCode or in Visual Studio.
- Commit the changes both for .cs and .md and follow the usual PR GitHub workflow.
DryIoc uses the compile-able runnable documentation written in .cs C# files in the markdown format - example.
That's a lot to say :-) so let me explain...
Markdown text is placed inside the /*md ... md*/ comments and
the examples are just the unit test classes outside of the markdown comment blocks.
The documentation files are included into the normal NUnit test project docs\DryIoc.Docs in the DryIoc solution. This way the docs are compiled as a normal code and the example tests are up-to-date and can be run locally or on the CI side.
The documentation .cs files are converted to the markdown .md file via CsToMd Visual Studio extension
and via the dotnet-cstomd dotnet CLI local tool which is already installed when you build the project.
There is a CsToMd repository with more information.
When installing the extension for the Visual Studio you will see that DryIoc.Docs project has a .md files located under corresponding the .cs files.
Try edit the .cs file then save it and see that the .md file is automatically changed by the extension.
The result markdown file may be automatically previewed inside the Visual Studio with the help of Markdown Editor extension.
In VSCode you need to run the build_the_docs.bat to see the changes or just build the DryIoc.Docs project in the Debug mode (the default).