search

ASKnet-Open-Training / Github-Guidance

Here you find all information about how to use Github and get support
https://asknet-open-training.github.io/Github-Guidance
Other
6 stars 6 forks source link

Is it usefull to make use of Commit comment function? #17

Closed timmwille closed 3 years ago

timmwille commented 3 years ago

in what case does it make sense to use the Commit comment functionality?

For example in this case I can see a lot of content that belongs into the repo code and/or wiki but definitely not in a commit comment: https://github.com/ASKnet-Open-Training/magnet-light/commit/d5dca34f904fd8862700d0c0c4e6398a37d5a6f9

chardso commented 3 years ago

Yeah ,it was so confusing to me as where to write my report from my findings, but I came to realise where to write them after I have already written them as commit comments,next time better.

timmwille commented 3 years ago

@bmen can you check?

chardso commented 3 years ago

How do I move the commit comments to a single file in the readme?

PyGamma commented 3 years ago

Thanks so much for this question, ideally commit comment in most cases are used to identify the commit one makes, it includes the statement to explain the changes you have done to the repository, and is it also the way the repository owner can reply to your request and notified the changes you are required to make if your code it to be merged in the master branched.