linting: Solve Markdown linting errors

pull/555/head
Emilio López 4 years ago
parent 0b2b2f6b7a
commit e9f4283323
  1. 12
      CONTRIBUTING.md
  2. 18
      README.md
  3. 5
      plugin_example/README.md
  4. 2
      slither/tools/demo/README.md
  5. 2
      slither/tools/erc_conformance/README.md
  6. 1
      tests/check-kspec/safeAdd/spec.md

@ -1,24 +1,24 @@
# Contributing to Slither # 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. 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. 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). 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/). 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: 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. - 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. - 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. - 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. - 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). Instructions for installing a development version of Slither can be found in our [wiki](https://github.com/crytic/slither/wiki/Developer-installation).

@ -31,13 +31,13 @@ Slither is a Solidity static analysis framework written in Python 3. It runs a s
## Bugs and Optimizations Detection ## Bugs and Optimizations Detection
Run Slither on a Truffle/Embark/Dapp/Etherlime application: Run Slither on a Truffle/Embark/Dapp/Etherlime application:
``` ```bash
slither . slither .
``` ```
Run Slither on a single file: Run Slither on a single file:
``` ```bash
$ slither tests/uninitialized.sol slither tests/uninitialized.sol
``` ```
For additional configuration, see the [usage](https://github.com/trailofbits/slither/wiki/Usage) documentation. 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 ### Using Pip
``` ```bash
$ pip3 install slither-analyzer pip3 install slither-analyzer
``` ```
### Using Git ### Using Git
```bash ```bash
$ git clone https://github.com/crytic/slither.git && cd slither git clone https://github.com/crytic/slither.git && cd slither
$ python3 setup.py install 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. 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. 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 docker pull trailofbits/eth-security-toolbox
``` ```
To share a directory in the container: To share a directory in the container:
``` ```bash
docker run -it -v /home/share:/share trailofbits/eth-security-toolbox docker run -it -v /home/share:/share trailofbits/eth-security-toolbox
``` ```

@ -7,13 +7,12 @@ See the [detector documentation](https://github.com/trailofbits/slither/wiki/Add
## Architecture ## Architecture
- `setup.py`: Contain the plugin information - `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. - `slither_my_plugin/detectors/example.py`: Detector plugin skeleton.
Once these files are updated with your plugin, you can install it: Once these files are updated with your plugin, you can install it:
``` ```bash
python setup.py develop python setup.py develop
``` ```
We recommend to use a Python virtual environment (for example: [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/en/latest/)). We recommend to use a Python virtual environment (for example: [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/en/latest/)).

@ -1,4 +1,4 @@
## Demo # Demo
This directory contains an example of Slither utility. This directory contains an example of Slither utility.

@ -1 +1 @@
## ERC conformance # ERC conformance

@ -1,3 +1,4 @@
# spec
```act ```act
behaviour add of SafeAdd behaviour add of SafeAdd

Loading…
Cancel
Save