This repository has been archived by the owner on Sep 20, 2021. It is now read-only.
Add details about commit type and title structure in the contributor guide. #32
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This PR is related to the RFC hoaproject/Central#61. |
Pierozi
reviewed
Jan 5, 2018
shulard
force-pushed
the
feature/define-commit-type
branch
from
7e9b5c0 to
3b23f1a
Compare
Hywan
suggested changes
Jan 22, 2018
shulard
force-pushed
the
feature/define-commit-type
branch
2 times, most recently
from
9d2ad36 to
0b3b744
Compare
|
Thank you for the feedback, I've updated the files with all the requested changes. |
shulard
force-pushed
the
feature/define-commit-type
branch
from
0b3b744 to
49e6cc3
Compare
|
Hello @vonglasow, @Hywan, I've checked to be sure that all the review comments have been processed, I think we are ready to go here 😄. |
shulard
force-pushed
the
feature/define-commit-type
branch
from
49e6cc3 to
c6324d8
Compare
|
@vonglasow, I've added the changes given by your colleague 😄. More simple and clearer than the previous version 😄. |
vonglasow
reviewed
Nov 21, 2018
Contributor/En/Guide.xyl
Outdated
| <h3 id="Commit_message_structure" for="main-toc">Commit message structure</h3> | ||
|
|
||
| <p>As seen in the previous section, a commit title must be less than 50 | ||
| characters long. This title must be precise and straightfoward and describe |
There was a problem hiding this comment.
Suggested change
| characters long. This title must be precise and straightfoward and describe | |
| characters long. This title must be precise and straightforward and describe |
vonglasow
approved these changes
Nov 21, 2018
|
@shulard since this modification is done it looks ok for me too. So I will merge it. If we have more feedback about this section we will create a new PR for that. |
Since we defined different commit types and a generic structure, the contributor guide must explain how to write a nice commit title.
shulard
force-pushed
the
feature/define-commit-type
branch
from
c6324d8 to
9d0fb34
Compare
|
I've updated the typo, thank for the feedback 😄. |
ghost
removed
the
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello !
I finally started to work on the contributor guide update regarding commit types. I've added some details about the commit title structure and the different commit types.
For me it's enough in this part, maybe I'm wrong. What are you thinking about ?