search

kadenzipfel / smart-contract-vulnerabilities

A collection of smart contract vulnerabilities along with prevention methods
https://kadenzipfel.github.io/smart-contract-vulnerabilities/
1.87k stars 256 forks source link

Add style-guide.md with clear formatting and styling rules #47

Closed polymawutor closed 4 months ago

polymawutor commented 4 months ago

This style guide was generated based on the style and formatting used in pre-existing texts. It is suitable to serve as the base guide while flexible enough to be fine-tuned over time. Fixes #38

polymawutor commented 4 months ago

Okay, thanks for the feedback. I added a line on updating the README, under Content Guidelines like this:

"When you add a new vulnerability and its corresponding markdown file, remember to update README.md with the new entry. "

I will be updating the PR with the changes.

kadenzipfel commented 4 months ago

@kadenzipfel, I was wondering where we should reference this style guide so that contributors can easily access it. Should we add a link to it in the README or place it somewhere else?

I think for now it's ok to just have it in the PR template, but open to other opinions