You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Missing "Contribute" section in README or docs #581
So it would be great for him to provide a small "Contribute" section in README.md (or a separate md in docs/) explaining what's needed before submitting code. Some questions which come to mind:
1- Commit style (already answered, "Conventional commits"
2- PR style (already answered, "one PR - one change")
3- coding standard (eg. linux kernel style for XDP code, etc.)
4- how to run unit tests locally
As a hint, check how all this is more or less covered eg. in Osmocom project:
BTW, let me take the chance to provide feedback on the fact that imho "one PR - one change" (aka 1 PR = 1 commit) really hits efficiency/productivity while contributing, because sometimes a bigger change requires small steps (eg. small refactoring, some dependency fix, etc.) which would ideally end up in a PR with several fully independent commits but which needs to be submitted in sequence because they depend on each other.
That means that to circumvent that limitation, I need to either:
1- Submit all those independent steps into 1 big commit which makes everyting more difficult to review, backport, debug, etc.
2- Wait until the first commit is merged so I can then submit a new PR rebasing on top of current main, which delays stuff quite a lot.
Since we don't have any certain described contribute section, I guess you can propose commit to our readme.md ) From other point of view, there are no much contributors now. So maybe you can go as it seems more affordable for you.
Activity
ewdss commentedon Nov 27, 2024
Hi @pespin !
Since we don't have any certain described contribute section, I guess you can propose commit to our readme.md ) From other point of view, there are no much contributors now. So maybe you can go as it seems more affordable for you.