search

OpenDataServices / developer-docs

Documentation about how we get our work done. For internal use, but happy to share
Other
1 stars 0 forks source link

Add Git Practices as agreed at meeting 14th feb 2020 #82

Closed odscjames closed 4 years ago

odscjames commented 4 years ago

Hey all, this is my attempt to write up the meeting we had - it might be good to get approval from a few people before merging, as there is a lot here. (Or comments/feedback, of course)

Lathrisk commented 4 years ago

Is it worth adding something about the .gitmessage templates? They're pretty trivial to set up so maybe it's just a bonus 'if you can be bothered' extra that doesn't need to be included in the actual docs.

i.e.

cat <<EOT > .gitmessage 
#<module/submodule/file/some logical name to make it uniquely identifiable in the codebase>: <Change summary message>
unique_name: summary_msg

#<Longer message if needed to describe the change>
body_msg

#<Full URLs: github issues, pull requests if applicable>
urls
EOT
git config --global commit.template ~/.gitmessage
Bjwebb commented 4 years ago

I would like to see the .gitmessage template in this docs repo (but not a blocker for this PR).

odscjames commented 4 years ago

@Lathrisk @Bjwebb Thanks! I just added a section on commit templates in a new commit.

odscjames commented 4 years ago

I see :-) I do have that in the actual examples on the page tho?