Skip to content

Latest commit

 

History

History
37 lines (27 loc) · 2.05 KB

File metadata and controls

37 lines (27 loc) · 2.05 KB

Hamnet SNMP Monitoring Tools Contribution guide

The project has been started by Kurt, DJ3MU.
It's written in C# as Dotnet Core application. It's using quite a couple of useful Nuget package for which I want to take the chance to say "Thank you" to all the package developers.

The code does not in any way claim to be perfect. I've tried to obey software design concepts and do clean coding as much as I could. But I'm really open to all kinds of improvement requests. Feel free to contact me or submit pull requests and I'll do my best to improve.

Everybody is encouraged to actively use the tool and report back bugs and/or new requirements.

Also Pull Requests for fixes are functional extensions are highly appreciated.

Building and deploying

From the root folder of repository run

dotnet build

To publish to a self-contained, frame-work-dependent executable (i.e. an executable with all required DLLs inside same folder) use

dotnet publish -c Release -r win10-x64

for or

dotnet publish -c Release -r linux-x64

For more platforms see the dotnet core runtime identifier catalog.

Configuration Management

Even though I've started on a single master branch, the tool is now using a GitFlow development model.

Continuous integration is currently being set up using Github Actions.

There are a couple of Unit Tests available. But they leave a lot of space for improvements. Unit testing also still needs to be added to the CI.

There is a packaging of the self-contained publish result for Linux-X64 as tar archive done by the CI.
But that archive is only available for download on the project's Github Actions page.

No automatic deployment is yet set up. Mainly because Github cannot easily access servers in Hamnet.