b2-sdk-python icon indicating copy to clipboard operation
b2-sdk-python copied to clipboard

Improve developer documentation

Open ehossack opened this issue 4 years ago • 1 comments

This could be as simple as updating the CONTRIBUTING.md to be more accessible:

  • start with recommended system installation of python(s) first before other sections
  • link to the configuration of the commands run on CI build + expectations on what is done locally vs. at pr-time
  • high-level overview of repo structure and test strategy (old strategy vs. new, where to add tests and when)
  • the need for a CHANGELOG message

Also I'd recommend trying a fresh setup by literally following the instructions, it's quite sparse, and as I said, I cannot get python <= 3.6 functioning on my machine, so others running a similar later version of macOS 11 are likely to experience the same issue.

ehossack avatar May 31 '21 15:05 ehossack

This sounds like a great idea. Would you care to adjust the documentation as outlined above, provide first draft at least? I'd help refine it, if you'd help start it up

ppolewicz avatar May 31 '21 15:05 ppolewicz