powellb / seapy

State Estimation and Analysis in Python
MIT License
28 stars 21 forks source link

Fix the README.md section on Contributing #60

Closed hadfieldnz closed 5 years ago

hadfieldnz commented 5 years ago

Since writing the section yesterday on Contributing I rediscovered this document

https://www.asmeurer.com/git-workflow/

I realised that I gave bad advice, in that I suggested cloning from the fork rather than the main project. This specifically warned against in the above document. It is a bad idea because it complicates things for a novice user, who might start by cloning from the main project, then want later to create a fork and clone from that. In the end, it's just a matter of which project is associated with the "origin" remote, but it's a good idea to stick to a simple, consistent workflow.

I have rewritten the Contributing section with a link to the above document.

Sorry for not getting it right first time.