SecLists icon indicating copy to clipboard operation
SecLists copied to clipboard

feat(docs): Added Conventional-Commits guidelines to the CONTRIBUTING.md (OPTION 2)

Open ItsIgnacioPortal opened this issue 1 year ago • 2 comments

As discussed in #1020

There's two ways of options for implementing the conventional-commits syntax into Seclists.

This is option 2

I've made a flowchart using mermaid, which is officially supported in github markdown. Then, I added it into the CONTRIBUTING.md file directly.

Benefits of this implementation:

  1. Cohesiveness: The mermaid format is rendered in such a way that it follows the github website style, making the whole CONTRIBUTING.md document more cohesive with the github styling.
  2. Selectable text: Contributors will be able to copy-paste the recommended syntaxes directly, facilitating their use of conventional-commits syntax in their contributions.

View the resulting CONTRIBUTING.md file

Now compare this with option 1: #1043

ItsIgnacioPortal avatar Jun 25 '24 07:06 ItsIgnacioPortal

@ItsIgnacioPortal I feel that this option would be better as users have an added option to zoom into the flow chart.

molangning avatar Jun 25 '24 09:06 molangning

@ItsIgnacioPortal +1 with @molangning

Just a remark about the following line:

image

I think that now the project is only managed by @g0tmi1k and this project do not have any relation with OWASP anymore. I based my pov on project page update and link into OWASP project ecosystem.

image

righettod avatar Jun 25 '24 14:06 righettod

Thank you for the feedback @righettod @molangning :thumbsup:

ItsIgnacioPortal avatar Jul 17 '24 02:07 ItsIgnacioPortal

Just a remark about the following line:

image

I think that now the project is only managed by @g0tmi1k and this project do not have any relation with OWASP anymore. I based my pov on project page update and link into OWASP project ecosystem.

Agreed. I've now removed that line from the CONTRIBUTING.md

ItsIgnacioPortal avatar Jul 17 '24 03:07 ItsIgnacioPortal

Thanks for all the work thats gone into this @ItsIgnacioPortal <3

g0tmi1k avatar Aug 12 '24 19:08 g0tmi1k