Skip to content

Missing "Contribute" section in README or docs #581

Closed

Description

@pespin

Describe the bug

While submitting a PR I was asked by @pirog-spb to "modify PR to satisfy conventional commits style (https://www.conventionalcommits.org/)", but AFAICT that's not documented anywhere.
In another PR, I was answered too with: Our PR management style is "one PR - one change"

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.

Activity

  1. ewdss commented on Nov 27, 2024

    @ewdss
    Member

    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.

  2. added this to the v0.7.1 milestone on Mar 1, 2025
  3. added theissue type on Apr 9, 2025
  4. linked a pull request that will close this issuedocs: add contributing guide #611on Apr 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions