Skip to content

Commit 565d767

Browse files
committed
Run prettier **/*.md --write
1 parent 4437a11 commit 565d767

File tree

98 files changed

+1630
-1278
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

98 files changed

+1630
-1278
lines changed

Diff for: CONTRIBUTING.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
11
# Contributing to Building-secure-contracts
2+
23
First, thanks for your interest in contributing to Building-secure-contracts! We welcome and appreciate all contributions, including bug reports, feature suggestions, tutorials/blog posts, and code improvements.
34

45
If you're unsure where to start, we recommend our [`good first issue`](https://github.com/crytic/building-secure-contracts/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) and [`help wanted`](https://github.com/crytic/building-secure-contracts/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) issue labels.
56

67
## Bug reports and feature suggestions
8+
79
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 [email protected] instead.
810

911
## Questions
12+
1013
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).
1114

1215
## Code
16+
1317
building-secure-contracts 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/).
1418

1519
Some pull request guidelines:
@@ -22,6 +26,7 @@ Some pull request guidelines:
2226
## Directory Structure
2327

2428
Below is a rough outline of building-secure-contracts's structure:
29+
2530
```text
2631
.
2732
├── development-guidelnes # High-level best-practices for all smart contracts
@@ -34,9 +39,10 @@ Below is a rough outline of building-secure-contracts's structure:
3439

3540
## Linters
3641

37-
We run [markdown-link-check](https://github.com/tcort/markdown-link-check) to ensure all the markdown links are correct.
42+
We run [markdown-link-check](https://github.com/tcort/markdown-link-check) to ensure all the markdown links are correct.
3843

3944
To install `markdown-link-check`:
45+
4046
```bash
4147
$ npm install -g markdown-link-check
4248
```
@@ -52,10 +58,10 @@ $ find . -name \*.md -print0 | xargs -0 -n1 markdown-link-check
5258
We use `mdbook` to generate [secure-contracts.com](https://secure-contracts.com/).
5359

5460
To run it locally:
61+
5562
```
5663
$ cargo install --git https://github.com/montyly/mdBook.git mdbook
5764
$ mdbook build
5865
```
5966

60-
6167
Note: we use https://github.com/montyly/mdBook.git, which contains https://github.com/rust-lang/mdBook/pull/1584.

Diff for: README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@ We welcome contributions, and you can contribute by following our [contributing
1818
- [Transaction Tracing](./learn_evm/tracing.md): Helper scripts and guidance for generating and navigating transaction traces
1919
- [Yellow Paper Guidance](./learn_evm/yellow-paper.md): Symbol reference for more easily reading the Ethereum yellow paper
2020
- [Forks <> EIPs](./learn_evm/eips_forks.md): Summarize the EIPs included in each Ethereum fork
21-
- [Forks <> CIPs](./learn_evm/cips_forks.md): Summarize the CIPs and EIPs included in each Celo fork *(EVM-compatible chain)*
22-
- [Upgrades <> TIPs](./learn_evm/tips_upgrades.md): Summarize the TIPs included in each TRON upgrade *(EVM-compatible chain)*
23-
- [Forks <> BEPs](./learn_evm/beps_forks.md): Summarize the BEPs included in each BSC fork *(EVM-compatible chain)*
21+
- [Forks <> CIPs](./learn_evm/cips_forks.md): Summarize the CIPs and EIPs included in each Celo fork _(EVM-compatible chain)_
22+
- [Upgrades <> TIPs](./learn_evm/tips_upgrades.md): Summarize the TIPs included in each TRON upgrade _(EVM-compatible chain)_
23+
- [Forks <> BEPs](./learn_evm/beps_forks.md): Summarize the BEPs included in each BSC fork _(EVM-compatible chain)_
2424
- [Not so smart contracts](./not-so-smart-contracts): Examples of smart contract common issues. Each issue contains a description, an example and recommendations
25-
- [Algorand](./not-so-smart-contracts/algorand)
26-
- [Cairo](./not-so-smart-contracts/cairo)
27-
- [Cosmos](./not-so-smart-contracts/cosmos)
28-
- [Substrate](./not-so-smart-contracts/substrate)
29-
- [Solana](./not-so-smart-contracts/solana)
25+
- [Algorand](./not-so-smart-contracts/algorand)
26+
- [Cairo](./not-so-smart-contracts/cairo)
27+
- [Cosmos](./not-so-smart-contracts/cosmos)
28+
- [Substrate](./not-so-smart-contracts/substrate)
29+
- [Solana](./not-so-smart-contracts/solana)
3030
- [Program analysis](./program-analysis): How to use automated tools to secure contracts
3131
- [Echidna](./program-analysis/echidna): a fuzzer that will check your contract's properties.
3232
- [Slither](./program-analysis/slither): a static analyzer available through a CLI and scriptable interface.
@@ -35,8 +35,8 @@ We welcome contributions, and you can contribute by following our [contributing
3535
- a theoretical introduction, a walkthrough of its API, and a set of exercises.
3636
- exercises expected to require ~two hours to practically learn its operation.
3737
- [Resources](./resources): Various online resources
38-
- [Trail of Bits blogposts](./resources/tob_blogposts.md): List of blockchain related blogposts made by Trail of Bits
39-
38+
- [Trail of Bits blogposts](./resources/tob_blogposts.md): List of blockchain related blogposts made by Trail of Bits
4039

4140
# License
42-
secure-contracts and building-secure-contracts are licensed and distributed under the [AGPLv3 license](https://github.com/crytic/building-secure-contracts/blob/master/LICENSE). Contact us if you're looking for an exception to the terms.
41+
42+
secure-contracts and building-secure-contracts are licensed and distributed under the [AGPLv3 license](https://github.com/crytic/building-secure-contracts/blob/master/LICENSE). Contact us if you're looking for an exception to the terms.

0 commit comments

Comments
 (0)