Skip to content

Commit fab880e

Browse files
authored
Apply suggestions from code review
Wording and grammar changes for CONTRIBUTING and README
1 parent f95ce33 commit fab880e

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ Here's a basic overview of Building-Secure-Contracts' structure:
2929

3030
```text
3131
.
32-
├── development-guidelnes # High-level best practices for all smart contracts
32+
├── development-guidelines # High-level best practices for all smart contracts
3333
├── learn_evm # EVM technical knowledge
3434
├── not-so-smart-contracts # Examples of common smart contract issues, including descriptions, examples, and recommendations
35-
├── program-analysis # How to utilize automated tools for securing contracts
35+
├── program-analysis # How to utilize automated tools to secure contracts
3636
├── resources # Various online resources
3737
└── ...
3838
```

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22

33
![](https://github.com/crytic/building-secure-contracts/workflows/CI/badge.svg) ![](https://github.com/crytic/building-secure-contracts/workflows/Echidna/badge.svg)
44

5-
Brought to you by [Trail of Bits](https://www.trailofbits.com/), this repository offers guidelines and best practices for developing secure smart contracts. Contributions are welcome, so please participate by adhering to our [contributing guidelines](https://github.com/crytic/building-secure-contracts/blob/master/CONTRIBUTING.md).
5+
Brought to you by [Trail of Bits](https://www.trailofbits.com/), this repository offers guidelines and best practices for developing secure smart contracts. Contributions are welcome, you can contribute by following our [contributing guidelines](https://github.com/crytic/building-secure-contracts/blob/master/CONTRIBUTING.md).
66

77
**Table of Contents:**
88

99
- [Development Guidelines](./development-guidelines)
10-
- [High-Level Best Practices](./development-guidelines/guidelines.md): Essential practices for all smart contracts
11-
- [Incident Response Recommendations](./development-guidelines/incident_response.md): Advice for creating an incident response plan
10+
- [High-Level Best Practices](./development-guidelines/guidelines.md): Best practices for all smart contracts
11+
- [Incident Response Recommendations](./development-guidelines/incident_response.md): Guidelines for creating an incident response plan
1212
- [Secure Development Workflow](./development-guidelines/workflow.md): A high-level process to follow during code development
1313
- [Token Integration Checklist](./development-guidelines/token_integration.md): What to check when interacting with arbitrary tokens
14-
- [Learn EVM](./learn_evm): Technical knowledge about EVM
14+
- [Learn EVM](./learn_evm): Technical knowledge about the EVM
1515
- [EVM Opcodes](./learn_evm/evm_opcodes.md): Information on all EVM opcodes
1616
- [Transaction Tracing](./learn_evm/tracing.md): Helper scripts and guidance for generating and navigating transaction traces
1717
- [Yellow Paper Guidance](./learn_evm/yellow-paper.md): Symbol reference for easier reading of the Ethereum yellow paper
@@ -28,13 +28,13 @@ Brought to you by [Trail of Bits](https://www.trailofbits.com/), this repository
2828
- [Program Analysis](./program-analysis): Using automated tools to secure contracts
2929
- [Echidna](./program-analysis/echidna): A fuzzer that checks your contract's properties
3030
- [Slither](./program-analysis/slither): A static analyzer with both CLI and scriptable interfaces
31-
- [Manticore](./program-analysis/manticore): A symbolic execution engine that proves correctness properties
32-
- Each tool comes with:
31+
- [Manticore](./program-analysis/manticore): A symbolic execution engine that proves the correctness of properties
32+
- For each tool, this training material provides:
3333
- A theoretical introduction, an API walkthrough, and a set of exercises
3434
- Exercises that take approximately two hours to gain practical understanding
3535
- [Resources](./resources): Assorted online resources
3636
- [Trail of Bits Blog Posts](./resources/tob_blogposts.md): A list of blockchain-related blog posts created by Trail of Bits
3737

3838
# License
3939

40-
Secure-contracts and building-secure-contracts are licensed and distributed under the [AGPLv3 license](https://github.com/crytic/building-secure-contracts/blob/master/LICENSE). Please contact us if you require an exception to the terms.
40+
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)