Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve developer documentation #255

Open
ehossack opened this issue May 31, 2021 · 1 comment
Open

Improve developer documentation #255

ehossack opened this issue May 31, 2021 · 1 comment

Comments

@ehossack
Copy link
Contributor

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.

@ppolewicz
Copy link
Collaborator

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants