search

numberscope / frontscope

Numberscope's front end and user interface: responsible for specifying sequences and defining and displaying visualizers
MIT License
7 stars 15 forks source link

doc: Harmonize guidance on git, cloning, and other workflows. #463

Closed gwhitney closed 1 month ago

gwhitney commented 1 month ago

By submitting this PR, I am indicating to the Numberscope maintainers that I have read and understood the contributing guidelines and that this PR follows those guidelines to the best of my knowledge. I have also read the pull request checklist and followed the instructions therein.

Resolves https://github.com/numberscope/frontscope/issues/221.

There is still a signifcant amount of repetition/overlap among CONTRIBUTING.md, and in the doc/ directory, onboarding.md, running-from-source.md, and working-with-git-and-github.md. I wasn't sure how we might compartmentalize these, because they are at different levels of detail and for different audiences.

Since they are all now consistent with each other, I am not too fussed by the repetitiveness. Maybe it's OK to give potential contributors multiple places to find the information they need. But if the reviewer has suggestions about how to reduce the redundancy, I am also open to making more changes.

Note this is a strictly doc-only PR. No operational source code is touched.

gwhitney commented 1 month ago

OK, I have attempted to make changes responsive to all of the comments above. Ready for further review (I hope ;-).

katestange commented 1 month ago

Looks great, Glen. I actually learned a lot reading through all that. I'm not worried about the repetitiveness right now.