I found it difficult to find the instructions for setting up a
development environment with my usual GitHub habits. In fact, I assumed
they don't exist and missed the very helpful information.
I hope that this commit will help others find them.
* added first draft of instructions for pull requests
* added a diagram to explain process
* added description of the process, moved specific instructions
- split the diagram into two parts to easy comperehension and
allow people to better follow the process
- added descriptions of the conceptual steps, keeping them
separate from specific instructions
- moved the specific instructions under a common heading to make
the ToC more readable
* added explanations
- added link to GitHub docu on forks
- added note on philosophy followed
- improved ToC structure
* tried to finalize process description (see below)
- added airline-style "pay attention to the instructions" tip
- added bit about testing with Material for MkDocs documentation
and examples from the examples repo
- added note on being respectful in discussion and on how sometimes
PRs do not get accepted for good reason
- improvements for readability
* moved the "philosophy" bit to the steps
IMHO this is a better place to make this point as the comments are
mainly about what tools are used, which is more relevant to the
instructions, not the 30k ft view process
* added more text to steps guidance, dos and don'ts
- added more text to pretty much every section under 'steps'
- added a section with dos and don'ts
- left some questions for @squidfunk to ponder
* addressing first set of comments
* addressed further comments
In particular:
- removed the bits about linters and
- about dealing with merge conflicts
These may perhaps need attention in the future.
* removing question about PR template