vaguecoder / gorilla-mux Goto Github PK

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

NA

Describe the solution you'd like

Add TODO Section in All Issue Templates

Describe alternatives you've considered

NA

Additional context

NA

Ownership of Contribution

If the triage is approved,

• I wish to submit the PR myself.
• I wish to submit the PR. But if someone is willing to do it, go ahead.
• I don't know how to fix this or make these changes. I wish others to pick this up for me.

Describe the Request/Issue

Add 2 new templates:

1. Misc. template for any non bug/feature/documentation request.
2. Documentation template for adding/fixing documentation.

Describe the Solution You Think

Add 2 templates in .github

Additional Context

Ownership of Contribution

If the triage is approved,

• I wish to submit the PR myself.

Describe the Request/Issue

Currently, we have 4 issue templates, among which feature is the closest to enhancements. However, it is better to have one enhancement template.

Describe the Solution You Think

Copy paste feature template as enhancement template with minor changes.

Additional Context

NA

Ownership of Contribution

If the triage is approved,

• I wish to submit the PR myself.
• I wish to submit the PR. But if someone is willing to do it, go ahead.
• I don't know how to fix this or make these changes. I wish others to pick this up for me.

Is it related to any existing issue, discussion or PR?

NA.

If about fixing existing tests, please explain in detail.

NA.

If about deletion of existing tests, please explain in detail.

NA

If about missing coverage, list in any of the following.

File(s):

1. route.go (Current coverage: 81.8%)

If about adding extra tests, list existing below and explain the reason.

NA

Additional context

NA

Ownership of Contribution

If the triage is approved,

• I wish to submit the PR myself.
• I wish to submit the PR. But if someone is willing to do it, go ahead.
• I don't know how to fix this or make these changes. I wish others to pick this up for me.

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

Need a step in the pipeline for analysis of security vulnerabilities.

Describe the solution you'd like

Add CodeQL to the pipeline.

Describe alternatives you've considered

Not sure.

Additional context

Refer etcd's CodeQL Step

Ownership of Contribution

If the triage is approved,

• I wish to submit the PR myself.
• I wish to submit the PR. But if someone is willing to do it, go ahead.
• I don't know how to fix this or make these changes. I wish others to pick this up for me.

Add a Makefile with targets like test at the very least.

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

No. Just that the repo is a fork and CircleCI is not active on it. I wish to migrate it to GitHub Actions.

Describe the solution you'd like

Create GitHub Action's workflows for

1. Linter (either golangci-lint if already available in project, or use the old school gofmt, golint, go vet, etc.
2. Go test

Describe alternatives you've considered

GitHub Actions

Additional context

Workflows of the following can be referenced:

1. etcd
2. gin

Ownership of Contribution

If the triage is approved,

• I wish to submit the PR. But if someone is willing to do it, go ahead.

We need to fix typos and doc corrections (grammar corrections)

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

NA

Describe the solution you'd like

Add linter step in test.yaml

Describe alternatives you've considered

A separate workflow would also work.

Additional context

NA

Ownership of Contribution

If the triage is approved,

• I wish to submit the PR myself.
• I wish to submit the PR. But if someone is willing to do it, go ahead.
• I don't know how to fix this or make these changes. I wish others to pick this up for me.

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

Naah!

Describe the solution you'd like

At this point, it is just an idea. Need to check if a GitHub action workflow can detect the todo tag and fail the workflow for the developer to manually check and finish the TODOs.

Describe alternatives you've considered

If automation on this doesn't work (or too much of hard work for this simple thing), we have to stick to manually checking before approving the PRs (for todo tags on both PR & issue).

Additional context

• todo tags on open issues/PRs can be found here.
• Initial thought of adding todo is to signify that the issue or PR has some action items which have to be converted as issues. But this can be open-ended in future.

TODO (if any)

Add details of what todo tag does, as explained above, in CONTRIBUTING.md

Ownership of Contribution

If the triage is approved,

• I wish to submit the PR myself.
• I wish to submit the PR. But if someone is willing to do it, go ahead.
• I don't know how to fix this or make these changes. I wish others to pick this up for me.

Describe the Bug

ioutil is deprecated. Replace all occurrences of ioutil with io or os w.r.t. the functions in use.

To Reproduce

NA

Additional Context

NA

Ownership of Contribution

If the triage is approved,

• I wish to submit the PR myself.
• I wish to submit the PR. But if someone is willing to do it, go ahead.
• I don't know how to fix this or make these changes. I wish others to pick this up for me.

Describe the Request/Issue

Since this is a fork, gorilla/mux v1.8.0 should be released as v0.0.0 here.

Describe the Solution You Think

Since gorilla mux is just a package and not a cmd tool, no releasers like goreleaser be used. However, the release page might need the source code section as in gorilla/mux v1.8.0.

The release page might require a template consisting

1. Release version details
2. Change log
3. Contributors

I've added release-drafter to the project. Hence the template changes have to be done in .github/release-drafter.yml. However, I'm not sure how to release the first-ever version.

Additional Context

Refer release-drafter for more info on how to fix the template and to release.

Ownership of Contribution

If the triage is approved,

• I wish to submit the PR myself.
• I wish to submit the PR. But if someone is willing to do it, go ahead.
• I don't know how to fix this or make these changes. I wish others to pick this up for me.

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

Yes. The first GitHub action that I just added using #18 needs some caching of dependency installation.

Describe the solution you'd like

Use actions/cache which already available with GitHub actions. A bit of exploration is required.

Describe alternatives you've considered

Not sure.

Additional context

rs/zerolog makes use of the actions/cache. Need to check if using it as is will do us any good or if there are better usable ways.

Ownership of Contribution

If the triage is approved,

• I wish to submit the PR myself.
• I wish to submit the PR. But if someone is willing to do it, go ahead.
• I don't know how to fix this or make these changes. I wish others to pick this up for me.

Is it related to any existing issue, discussion or PR?

NA.

If about fixing existing tests, please explain in detail.

NA.

If about deletion of existing tests, please explain in detail.

NA

If about missing coverage, list in any of the following.

File(s):

1. mux.go (Current coverage: 90.3%)

If about adding extra tests, list existing below and explain the reason.

NA

Additional context

NA

Ownership of Contribution

If the triage is approved,

• I wish to submit the PR myself.
• I wish to submit the PR. But if someone is willing to do it, go ahead.
• I don't know how to fix this or make these changes. I wish others to pick this up for me.

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

NA

Describe the solution you'd like

Add CodeCov bot in GitHub actions.

Describe alternatives you've considered

Not sure. I need to check.

Additional context

It's good to have a check.

Ownership of Contribution

If the triage is approved,

• I wish to submit the PR myself.
• I wish to submit the PR. But if someone is willing to do it, go ahead.
• I don't know how to fix this or make these changes. I wish others to pick this up for me.

1. Just replace the archive statement with details about the forking.
2. Replace the module path in go.mod so it can be downloaded using go get -u github.com/vaguecoder/gorilla-mux

Upgrade the go version to the latest in

1. Go modules
2. Circle CI GitHub Actions

What?

Currently, all examples are on README.md making scroll forever. Need to move them to a directory examples/ with respective document names and hyperlinks, except for installation and examples (which only has 3 code blocks).

Why?

README.md too lengthy.

Additional Context

NA

Ownership of Contribution

If the triage is approved,

• I wish to submit the PR myself.
• I wish to submit the PR. But if someone is willing to do it, go ahead.
• I don't know how to fix this or make these changes. I wish others to pick this up for me.

Is it related to any existing issue, discussion or PR?

NA.

If about fixing existing tests, please explain in detail.

NA.

If about deletion of existing tests, please explain in detail.

NA

If about missing coverage, list in any of the following.

File(s):

1. regexp.go (Current coverage: 91.5%)

If about adding extra tests, list existing below and explain the reason.

NA

Additional context

NA

Ownership of Contribution

If the triage is approved,

• I wish to submit the PR myself.
• I wish to submit the PR. But if someone is willing to do it, go ahead.
• I don't know how to fix this or make these changes. I wish others to pick this up for me.

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

Currently, we only check coverage in local run with manual validation. Need to automate for CI/CD.

Describe the solution you'd like

Need a script that will fail if the expected threshold is not met. This can then be run from GitHub actions on every push or PR.

Describe alternatives you've considered

Make target would also do the trick. But as the commands grow in size, it gets a hassle to overload makefile.

Additional context

1. GitHub actions already have the unit test run workflow(s). Just need to add a separate workflow of coverage check.
2. If using a script, it should run on bash (zsh user myself, I still think bash is the standard). Syntax differences of different shells or WSL is a headache of the future developers.

Ownership of Contribution

If the triage is approved,

• I wish to submit the PR myself.
• I wish to submit the PR. But if someone is willing to do it, go ahead.
• I don't know how to fix this or make these changes. I wish others to pick this up for me.

Describe the Request/Issue

Need issue template for tests.

Describe the Solution You Think

Create issue templates similar to these for tests.

Additional Context

NA

Ownership of Contribution

If the triage is approved,

• I wish to submit the PR myself.
• I wish to submit the PR. But if someone is willing to do it, go ahead.
• I don't know how to fix this or make these changes. I wish others to pick this up for me.

Add golangci-lint to the project and add the target to Makefile

What?

We need CONTRIBUTING.md for guidelines on contributing to this project. It should have detail on

1. What copyleft license is included (the original gorilla mux has BSD-3 and we are leaving it as is)
2. Every commit should be signed, and DCO bot checks for it, etc.
3. How to test in local before committing changes
4. Milestones and versioning
5. Issue types
6. Label types

Why?

As communication on issue/PR is hard, it is better to clarify a few things for contributors.

Additional Context

Samples:

1. Kanister's
2. Helm's
3. Etcd's

Ownership of Contribution

If the triage is approved,

• I wish to submit the PR myself.
• I wish to submit the PR. But if someone is willing to do it, go ahead.
• I don't know how to fix this or make these changes. I wish others to pick this up for me.