search

SignalK / specification

Signal K is a JSON-based format for storing and sharing marine data from different sources (e.g. nmea 0183, 2000, seatalk, etc)
Other
91 stars 69 forks source link

WIP: docs: add notes covering naming conventions for pull requests #451

Closed bkp7 closed 6 years ago

bkp7 commented 6 years ago

First draft covering naming conventions for PRs and commits re issue #450.

Where should this be placed? I am thinking this becomes a section of Developer Notes which can be expanded to cover coding styles, etc in future, probably linked to the 'how can I help section'.

tkurki commented 6 years ago

https://help.github.com/articles/setting-guidelines-for-repository-contributors/

tkurki commented 6 years ago

This looks good! I think references to more detailed explanations would make sense. Also references could be links, like changelog.

Changelog is currently generated from prs, not commits.

tkurki commented 6 years ago

I would like to have other authors like Tim and Rob to comment on this.

timmathews commented 6 years ago

This looks good.

Let’s add a note to limit commit message subjects to 50 characters. It’s kind of convention in git and in fact GitHub wraps long subjects into the body of the commit message and truncates with an ellipsis see c375cd7 as an example.

Git has a 72 character commit message line length convention also, but that one seems less important. Not so many folks use an 80 character terminal.

ETA: That character limit only seems to apply to commit message subjects, there is no limit for issues or pull requests.

tkurki commented 6 years ago

I believe it is better to merge this & add more stuff incrementally as needed.