Update/rewrite contribution example, clean changelog instructions #396
Conversation
Rewrite the contribution example to be written in neutral style.
LaakkonenJussi
changed the title
Drop the tags as they are for internal use only. Emphasize the maintainer role in formatting the contribution at merge stage.
LaakkonenJussi
force-pushed
the
jb61617_2
branch
from
9d982db
to
80b903c
Compare
These are not relevant with current sfdk. The instructions on how to add and use additional repositories should be put elsewhere under advanced help as this is not something a regular contributor should be required to do.
LaakkonenJussi
force-pushed
the
jb61617_2
branch
from
cc8e533
to
6438fe6
Compare
|
Reads good so far to me. I just wonder that removing docs about commit suffixes entirely isn't as good. |
Many git repositories now have some kind of reference to an issue the change is either resolving or connected to. Our bug references are not relevant for contributing a change so it is good to drop it from here to avoid more confusion. Many, who have the expertise to contribute, will already have the understanding of the basic concepts of bug/issue reference anyways, but it would not hurt to find a some common place to document that. I think contribution example is not the place. |
Rewrite the contribution example to be written in neutral style.