Proposal: Add CONTRIBUTING.md to Improve Developer Onboarding

PoLo - Development
1

Hi, all.

I was having a look at the GitHub page, for this brilliant project. I was looking specifically at the repo front-page, and wondered whether it needed a slightly different approach to documenting contributing/ onboarding of devs. Full transparency, I asked an online AI agent for guidance on how to word this for the forum.

After reviewing the GitHub repo, I noticed there’s no CONTRIBUTING.md file, which could help new developers get started more easily.

What I’m proposing:

  • A CONTRIBUTING.md file that includes:
    • Clear setup instructions (especially for Mapbox configuration)
    • Code style guidelines
    • PR submission process
    • Brief architecture overview
    • How to run tests (if applicable)
    • Link to this forum for support

Why this helps:

  • Makes it easier for new contributors to jump in
  • Reduces setup frustration (I see the README mentions manual redux-persist
    installation, which suggests some setup issues)
  • Creates a standard for code contributions

Questions for the maintainers:

  • Are there existing coding standards that should be documented?
  • What’s the preferred PR process?
  • Any specific architecture patterns contributors should follow?

Is this helpful?

Cheers/ 73,

Chris
[2E0FRU]

2

100% agree, Chris

But you know where this is going, don’t you :sweat_smile:

I invite you to join our discord where we can help you get set up, answer some of these questions, and your first PR can be this very same CONTRIBUTING guide.

1 Like