docs(networking): add fwdctl project

alegrey91 commented 5 months ago

We want to ensure high quality of the packages. Make sure that you've checked the boxes below before sending a pull request.

[x] I have read the Contribution Guidelines
[x] I have read the Maintainers Note
[x] I have read the Quality Standards

Not every repository (project) will require every option, but most projects should. Check the Contribution Guidelines for details.

[x] The repo documentation has a pkg.go.dev link.
[x] The repo documentation has a coverage service link.
[x] The repo documentation has a goreportcard link.
[x] The repo has a version-numbered release and a go.mod file.
[x] The repo has a continuous integration process that automatically runs tests that must pass before new pull requests are merged.
[x] Continuous integration is used to attempt to catch issues prior to releasing this package to end-users.

Please provide some links to your package to ease the review

[x] forge link (github.com, gitlab.com, etc): github.com/alegrey91/fwdctl
[x] pkg.go.dev: https://pkg.go.dev/github.com/alegrey91/fwdctl
[x] goreportcard.com: https://goreportcard.com/report/github.com/alegrey91/fwdctl
[ ] coverage service link (codecov, coveralls, etc.): manually checking by using unit/integration test code coverage

Pull Request content

[x] The package has been added to the list in alphabetical order.
[x] The package has an appropriate description with correct grammar.
[x] As far as I know, the package has not been listed here before.

Category quality

Note that new categories can be added only when there are 3 packages or more.

Packages added a long time ago might not meet the current guidelines anymore. It would be very helpful if you could check 3-5 packages above and below your submission to ensure that they also still meet the Quality Standards.

Please delete one of the following lines:

[x] The packages around my addition still meet the Quality Standards.

Thanks for your PR, you're awesome! :sunglasses:

alegrey91 commented 4 months ago

Hi @phanirithvij!

the image in the readme is not visible properly in GitHub's dark mode please fix it.

I've updated the logo and other images to be visible with dark mode.

coverage should be able 80% or above. If not possible please state the reason why.

For test coverage, as you can see here: https://raw.githack.com/wiki/alegrey91/fwdctl/coverage.html#file0 most of the files are covered and with an high percentage. Some percentage is low due to the test suite with testscript. Eg. In this file: https://raw.githack.com/wiki/alegrey91/fwdctl/coverage.html#file12 The percentage is ~26%, but as you can see, in the test file, most of its behavior is tested: https://github.com/alegrey91/fwdctl/blob/main/tests/daemon.txtar The problem is that, in this case, the command doesn't return (because it's an infinite loop) and the coverage is never added. Another problem is with the following file: https://raw.githack.com/wiki/alegrey91/fwdctl/coverage.html#file12, that has a 0% of coverage. It was useless (IMO) test something that is "static", but the average of coverage lower down due to this file probably.

coverage should be able 80% or above. If not possible please state the reason why. the image in the readme is not visible properly in GitHub's dark mode please fix it. gofmt -s, or use gofumpt or golangci-lint

I'm already using golangci-lint in my CI (https://github.com/alegrey91/fwdctl/blob/main/.github/workflows/lint.yml), but it doens't raise any issue. Additionally, in this commit: https://github.com/alegrey91/fwdctl/commit/f5339aa977e87bac7e26e30117f48bc386c1087f, I've typed gofmt -s on the whole project, but these are the only files changed. Do you have any idea why?

phanirithvij commented 4 months ago

Not sure why gofmt -s is behaving that way maybe try gofumpt another alternative which does something like gofmt -s internally as well.

avelino / awesome-go