Conversation
Moving the contributing section into its own separate file Signed-off-by: Bill Mulligan <billmulligan516@gmail.com>
Signed-off-by: Bill Mulligan <billmulligan516@gmail.com>
CONTRIBUTING.md
Outdated
|
|
||
| ## Development Guidelines | ||
|
|
||
| - Follow Cilium's general [Developer Guide](https://docs.cilium.io/en/stable/contributing/development/) for coding standards and best practices. |
There was a problem hiding this comment.
The developer guide link here has a lot of content, and it is all tailored towards developing on cilium/cilium. I'm not sure whether new contributors for pwru without cilium background would have a good chance of finding the relevant info here. I agree in principle the coding standards & best practices are likely well aligned between the subprojects, but I'm not sure which parts of the linked contributing guide are relevant for pwru.
There was a problem hiding this comment.
Something like https://docs.cilium.io/en/stable/contributing/development/contributing_guide/#how-to-contribute is probably more practical, but there's still a few steps that aren't necessary for pwru, such as steps 7, 9-13.
There was a problem hiding this comment.
Overall the ideal is probably more that we enforce the "coding standards and best practices" via GitHub workflows so they apply automatically rather than just documenting them and hoping contributors will follow. But that would involve more work on the GHA side in this repo. I'm thinking stuff like adding golangci-lint to lint for common errors for instance.
CONTRIBUTING.md
Outdated
| ## Development Guidelines | ||
|
|
||
| - Follow Cilium's general [Developer Guide](https://docs.cilium.io/en/stable/contributing/development/) for coding standards and best practices. | ||
| - Before submitting a pull request, review the [Code Review Guidelines](https://docs.cilium.io/en/stable/contributing/code-reviews/). |
There was a problem hiding this comment.
Broken link, did you mean https://docs.cilium.io/en/stable/contributing/development/contributing_guide/#getting-a-pull-request-merged ?
Signed-off-by: Bill Mulligan <billmulligan516@gmail.com>
Signed-off-by: Bill Mulligan <billmulligan516@gmail.com>
joestringer
left a comment
There was a problem hiding this comment.
LGTM with the extra proposed wording changes but I'll defer to @cilium/pwru-maintainers for approval/merging.
|
maybe rebase to let ci checks pass? |
Signed-off-by: Bill Mulligan <billmulligan516@gmail.com>
CONTRIBUTING.md
Outdated
| - Read the [README](https://github.com/cilium/pwru#readme) to understand how `pwru` works and its use cases. | ||
| - Check out the [issues list](https://github.com/cilium/pwru/issues) for open tasks, especially those labeled `good first issue`. | ||
|
|
||
| ## Developing |
There was a problem hiding this comment.
Could we keep this section in the README.md, and then reference from CONTRIBUTING.md? I'm afraid that many might not look into the CONTRIBUTING.md to find those details.
There was a problem hiding this comment.
which section do you mean exactly? The developing section?
There was a problem hiding this comment.
Yep, the ## Developing. Could we keep it in the README.md?
Signed-off-by: Bill Mulligan <billmulligan516@gmail.com>
Signed-off-by: Bill Mulligan <billmulligan516@gmail.com>
Signed-off-by: Bill Mulligan <billmulligan516@gmail.com>
Moving the developing and contributing sections out of the main README into a separate file like most projects