From e9f4283323380459b288d31be4eb74e565bb5c9b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Emilio=20L=C3=B3pez?= Date: Wed, 22 Jul 2020 20:19:55 -0300 Subject: [PATCH] linting: Solve Markdown linting errors --- CONTRIBUTING.md | 12 ++++++------ README.md | 18 +++++++++--------- plugin_example/README.md | 5 ++--- slither/tools/demo/README.md | 2 +- slither/tools/erc_conformance/README.md | 2 +- tests/check-kspec/safeAdd/spec.md | 1 + 6 files changed, 20 insertions(+), 20 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8e767e47c..13bdc5859 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,24 +1,24 @@ # Contributing to Slither First, thanks for your interest in contributing to Slither! We welcome and appreciate all contributions, including bug reports, feature suggestions, tutorials/blog posts, and code improvements. -If you're unsure where to start, we recommend our [`good first issue`](https://github.com/crytic/slither/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) and [`help wanted`](https://github.com/crytic/slither/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) issue labels. +If you're unsure where to start, we recommend our [`good first issue`](https://github.com/crytic/slither/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) and [`help wanted`](https://github.com/crytic/slither/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) issue labels. -# Bug reports and feature suggestions +## Bug reports and feature suggestions Bug reports and feature suggestions can be submitted to our issue tracker. For bug reports, attaching the contract that caused the bug will help us in debugging and resolving the issue quickly. If you find a security vulnerability, do not open an issue; email opensource@trailofbits.com instead. -# Questions +## Questions Questions can be submitted to the issue tracker, but you may get a faster response if you ask in our [chat room](https://empireslacking.herokuapp.com/) (in the #ethereum channel). -# Code +## Code Slither uses the pull request contribution model. Please make an account on Github, fork this repo, and submit code contributions via pull request. For more documentation, look [here](https://guides.github.com/activities/forking/). Some pull request guidelines: -- Work from the [`dev`](https://github.com/crytic/slither/tree/dev) branch. We performed extensive tests prior to merging anything to `master`, working from `dev` will allow us to merge your work faster. +- Work from the [`dev`](https://github.com/crytic/slither/tree/dev) branch. We performed extensive tests prior to merging anything to `master`, working from `dev` will allow us to merge your work faster. - Minimize irrelevant changes (formatting, whitespace, etc) to code that would otherwise not be touched by this patch. Save formatting or style corrections for a separate pull request that does not make any semantic changes. - When possible, large changes should be split up into smaller focused pull requests. - Fill out the pull request description with a summary of what your patch does, key changes that have been made, and any further points of discussion, if applicable. - Title your pull request with a brief description of what it's changing. "Fixes #123" is a good comment to add to the description, but makes for an unclear title on its own. -# Development Environment +## Development Environment Instructions for installing a development version of Slither can be found in our [wiki](https://github.com/crytic/slither/wiki/Developer-installation). diff --git a/README.md b/README.md index d9c9ebe74..0426c250a 100644 --- a/README.md +++ b/README.md @@ -31,13 +31,13 @@ Slither is a Solidity static analysis framework written in Python 3. It runs a s ## Bugs and Optimizations Detection Run Slither on a Truffle/Embark/Dapp/Etherlime application: -``` +```bash slither . ``` Run Slither on a single file: -``` -$ slither tests/uninitialized.sol +```bash +slither tests/uninitialized.sol ``` For additional configuration, see the [usage](https://github.com/trailofbits/slither/wiki/Usage) documentation. @@ -136,15 +136,15 @@ Slither requires Python 3.6+ and [solc](https://github.com/ethereum/solidity/), ### Using Pip -``` -$ pip3 install slither-analyzer +```bash +pip3 install slither-analyzer ``` ### Using Git ```bash -$ git clone https://github.com/crytic/slither.git && cd slither -$ python3 setup.py install +git clone https://github.com/crytic/slither.git && cd slither +python3 setup.py install ``` We recommend using an Python virtual environment, as detailed in the [Developer Installation Instructions](https://github.com/trailofbits/slither/wiki/Developer-installation), if you prefer to install Slither via git. @@ -153,13 +153,13 @@ We recommend using an Python virtual environment, as detailed in the [Developer Use the [`eth-security-toolbox`](https://github.com/trailofbits/eth-security-toolbox/) docker image. It includes all of our security tools and every major version of Solidity in a single image. `/home/share` will be mounted to `/share` in the container. -``` +```bash docker pull trailofbits/eth-security-toolbox ``` To share a directory in the container: -``` +```bash docker run -it -v /home/share:/share trailofbits/eth-security-toolbox ``` diff --git a/plugin_example/README.md b/plugin_example/README.md index fc711f5d1..6f8c4a6c1 100644 --- a/plugin_example/README.md +++ b/plugin_example/README.md @@ -7,13 +7,12 @@ See the [detector documentation](https://github.com/trailofbits/slither/wiki/Add ## Architecture - `setup.py`: Contain the plugin information -- `slither_my_plugin/__init__.py`: Contain `make_plugin()`. The function must return the list of new detectors and printers +- `slither_my_plugin/__init__.py`: Contain `make_plugin()`. The function must return the list of new detectors and printers - `slither_my_plugin/detectors/example.py`: Detector plugin skeleton. Once these files are updated with your plugin, you can install it: -``` +```bash python setup.py develop ``` We recommend to use a Python virtual environment (for example: [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/en/latest/)). - diff --git a/slither/tools/demo/README.md b/slither/tools/demo/README.md index 00bdec0b4..2ed90692c 100644 --- a/slither/tools/demo/README.md +++ b/slither/tools/demo/README.md @@ -1,4 +1,4 @@ -## Demo +# Demo This directory contains an example of Slither utility. diff --git a/slither/tools/erc_conformance/README.md b/slither/tools/erc_conformance/README.md index a04677a65..6b50ce27f 100644 --- a/slither/tools/erc_conformance/README.md +++ b/slither/tools/erc_conformance/README.md @@ -1 +1 @@ -## ERC conformance \ No newline at end of file +# ERC conformance diff --git a/tests/check-kspec/safeAdd/spec.md b/tests/check-kspec/safeAdd/spec.md index 5fa1f516a..433ad25c5 100644 --- a/tests/check-kspec/safeAdd/spec.md +++ b/tests/check-kspec/safeAdd/spec.md @@ -1,3 +1,4 @@ +# spec ```act behaviour add of SafeAdd