Skip to content

Latest commit

 

History

History
76 lines (49 loc) · 3.16 KB

CONTRIBUTING.md

File metadata and controls

76 lines (49 loc) · 3.16 KB
Raw

Contributing to Building-Secure-Contracts

First, thank you for your interest in contributing to Building-Secure-Contracts! We appreciate and warmly welcome all contributions, which include bug reports, feature suggestions, tutorials/blog posts, and code improvements.

If you're not sure where to begin, we recommend checking out our good first issue and help wanted issue labels.

Bug Reports and Feature Suggestions

Please submit bug reports and feature suggestions to our issue tracker. When reporting a bug, attaching the contract causing the issue is helpful for efficient debugging and resolution. If you discover a security vulnerability, do not open an issue; instead, email [email protected].

Questions

Questions can be submitted to the issue tracker, but you may get a faster response if you ask in our chat room (in the #ethereum channel).

Code Contributions

Building-Secure-Contracts follows the pull request contribution model. Create an account on Github, fork this repo, and submit code contributions through pull requests. For additional documentation, refer here.

Some pull request guidelines:

  • Limit unnecessary changes (formatting, whitespace, etc.) to code unrelated to the patch. Save formatting or style corrections for a separate pull request, which doesn't include any semantic changes.
  • When possible, break down large changes into smaller, focused pull requests.
  • Complete the pull request description with an overview of your patch, including key modifications, and any further discussion points if relevant.
  • Use a concise title to describe your pull request's changes. "Fixes #123" is suitable for adding to the description, but not as a standalone title.

Directory Structure

Here's a basic overview of Building-Secure-Contracts' structure:

.
├── development-guidelines # High-level best practices for all smart contracts
├── learn_evm # EVM technical knowledge
├── not-so-smart-contracts # Examples of common smart contract issues, including descriptions, examples, and recommendations
├── program-analysis # How to utilize automated tools to secure contracts
├── resources # Various online resources
└── ...

Linting and Formatting

To install the formatters and linters, run:

npm install

To use the formatter, run:

npm run format

To use the linters, run:

npm run lint

To use individual linters, run:

  • npm run lint:format to check the formatting
  • npm run lint:links to verify the validity of links in markdown files

Creating the Book

We utilize mdbook to generate 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 rust-lang/mdBook#1584.