Skip to content

Commit

Permalink
Run prettier **/*.md --write
Browse files Browse the repository at this point in the history
  • Loading branch information
0xPhaze committed Mar 8, 2023
1 parent 4437a11 commit 565d767
Show file tree
Hide file tree
Showing 98 changed files with 1,630 additions and 1,278 deletions.
10 changes: 8 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
# Contributing to Building-secure-contracts

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.

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.

## 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 [email protected] instead.

## 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

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/).

Some pull request guidelines:
Expand All @@ -22,6 +26,7 @@ Some pull request guidelines:
## Directory Structure

Below is a rough outline of building-secure-contracts's structure:

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

## Linters

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

To install `markdown-link-check`:

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

To run it locally:

```
$ cargo install --git https://github.com/montyly/mdBook.git mdbook
$ mdbook build
```


Note: we use https://github.com/montyly/mdBook.git, which contains https://github.com/rust-lang/mdBook/pull/1584.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ We welcome contributions, and you can contribute by following our [contributing
- [Transaction Tracing](./learn_evm/tracing.md): Helper scripts and guidance for generating and navigating transaction traces
- [Yellow Paper Guidance](./learn_evm/yellow-paper.md): Symbol reference for more easily reading the Ethereum yellow paper
- [Forks <> EIPs](./learn_evm/eips_forks.md): Summarize the EIPs included in each Ethereum fork
- [Forks <> CIPs](./learn_evm/cips_forks.md): Summarize the CIPs and EIPs included in each Celo fork *(EVM-compatible chain)*
- [Upgrades <> TIPs](./learn_evm/tips_upgrades.md): Summarize the TIPs included in each TRON upgrade *(EVM-compatible chain)*
- [Forks <> BEPs](./learn_evm/beps_forks.md): Summarize the BEPs included in each BSC fork *(EVM-compatible chain)*
- [Forks <> CIPs](./learn_evm/cips_forks.md): Summarize the CIPs and EIPs included in each Celo fork _(EVM-compatible chain)_
- [Upgrades <> TIPs](./learn_evm/tips_upgrades.md): Summarize the TIPs included in each TRON upgrade _(EVM-compatible chain)_
- [Forks <> BEPs](./learn_evm/beps_forks.md): Summarize the BEPs included in each BSC fork _(EVM-compatible chain)_
- [Not so smart contracts](./not-so-smart-contracts): Examples of smart contract common issues. Each issue contains a description, an example and recommendations
- [Algorand](./not-so-smart-contracts/algorand)
- [Cairo](./not-so-smart-contracts/cairo)
- [Cosmos](./not-so-smart-contracts/cosmos)
- [Substrate](./not-so-smart-contracts/substrate)
- [Solana](./not-so-smart-contracts/solana)
- [Algorand](./not-so-smart-contracts/algorand)
- [Cairo](./not-so-smart-contracts/cairo)
- [Cosmos](./not-so-smart-contracts/cosmos)
- [Substrate](./not-so-smart-contracts/substrate)
- [Solana](./not-so-smart-contracts/solana)
- [Program analysis](./program-analysis): How to use automated tools to secure contracts
- [Echidna](./program-analysis/echidna): a fuzzer that will check your contract's properties.
- [Slither](./program-analysis/slither): a static analyzer available through a CLI and scriptable interface.
Expand All @@ -35,8 +35,8 @@ We welcome contributions, and you can contribute by following our [contributing
- a theoretical introduction, a walkthrough of its API, and a set of exercises.
- exercises expected to require ~two hours to practically learn its operation.
- [Resources](./resources): Various online resources
- [Trail of Bits blogposts](./resources/tob_blogposts.md): List of blockchain related blogposts made by Trail of Bits

- [Trail of Bits blogposts](./resources/tob_blogposts.md): List of blockchain related blogposts made by Trail of Bits

# License
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.

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.
Loading

0 comments on commit 565d767

Please sign in to comment.