Skip to content

Commit

Permalink
Git misc
Browse files Browse the repository at this point in the history
  • Loading branch information
kevin-valerio committed Aug 29, 2024
1 parent c8c7b5d commit 0f434bd
Show file tree
Hide file tree
Showing 6 changed files with 123 additions and 5 deletions.
8 changes: 8 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# See <https://help.github.com/articles/about-codeowners/>
# for more info about CODEOWNERS file
# It uses the same pattern rule for gitignore file
# <https://git-scm.com/docs/gitignore#_pattern_format>

# Maintainers

* @srlabs @kevin-valerio
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
name: Bug report
about: Create an issue about a bug you encountered
title: ''
---

<!--
Hi there, sorry `phink` is not working as expected.
Please fill this bug report conscientiously.
A detailed and complete issue is more likely to be processed quickly.
-->

## Description

<!--
A clear and concise description of what the bug is.
-->

## To Reproduce

<!--
Try to reduce the issue to a simple code sample exhibiting the problem.
Ideally, fork the project and add a test or an example.
-->

## Expected behavior

<!--
A clear and concise description of what you expected to happen.
-->

## Screenshots

<!--
If applicable, add screenshots, gifs or videos to help explain your problem.
-->

## Environment

<!--
Add a description of the systems where you are observing the issue. For example:
- OS: Linux
- Terminal Emulator: xterm
- Font: Inconsolata (Patched)
- Crate version: 0.7
- Backend: termion
-->

- OS:
- Terminal Emulator:
- Font:
- Crate version:
- Backend:

## Additional context

<!--
Add any other context about the problem here.
If you already looked into the issue, include all the leads you have explored.
-->
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: Discord Chat
url: https://discord.gg/gAahQMGE
about: Ask questions about Phink on Discord
- name: Github issue
url: https://github.com/srlabs/phink/issues
about: Submit your issue (improvement idea, bug...) on Github
- name: Direct Mail
url: mailto:kevin@srlabs.de
about: Exchange a feedback via mail to the main maintainer
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Feature request
about: Suggest an idea for this Phink
title: ''

---

## Problem

<!--
A clear and concise description of what the problem is.
-->

## Solution or steps towards

<!--
A clear and concise description of what you want to happen.
Things to consider:
-->

## Alternatives

<!--
A clear and concise description of any alternative solutions or features you've considered.
-->

## Additional context

<!--
Add any other context or screenshots about the feature request here.
-->
6 changes: 3 additions & 3 deletions .rustfmt.toml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
max_width = 90 # changed
max_width = 100 # changed
hard_tabs = false
tab_spaces = 4
newline_style = "Auto"
Expand All @@ -7,9 +7,9 @@ indent_style = "Block"
wrap_comments = true # changed
format_code_in_doc_comments = true # changed
doc_comment_code_block_width = 100 # changed
comment_width = 90 # changed
comment_width = 100 # changed
normalize_comments = true # changed
normalize_doc_attributes = false
normalize_doc_attributes = true
format_strings = false
format_macro_matchers = false
format_macro_bodies = true
Expand Down
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,24 @@
# 🐙 Phink

![Build Status](https://github.com/srlabs/phink/actions/workflows/rust.yml/badge.svg)
[![License](https://img.shields.io/github/license/srlabs/phink)](https://github.com/srlabs/phink/blob/main/LICENSE)
[![dependency status](https://deps.rs/repo/github/srlabs/phink/status.svg)](https://deps.rs/repo/github/srlabs/phink)
[![Discord](https://img.shields.io/discord/1276519988349374587.svg?label=&logo=discord&logoColor=ffffff&color=7289DA&labelColor=2C2F33)](https://discord.gg/gAahQMGE)

**Phink** is a blazing-fast⚡, property-based, coverage-guided fuzzer for ink! smart contracts. It enables developers to
embed inviolable properties into their smart contract testing workflows, equipping them with automatic tools to detect
vulnerabilities and ensure contract reliability before deployment.

> ⚠️ This project is actively under development with new features and improvements being made regularly. Contributions
and feedback are welcome!
> and feedback are welcome!
If you have any question, would like to share feedback, discuss features, and connect with other ink! developers, join
our [Discord community](https://discord.gg/gAahQMGE)

## Install

### Manual Installation

If you prefer to install Phink manually, follow these steps:

```bash
Expand Down Expand Up @@ -125,7 +131,9 @@ Job is done! Please, don't matter the backtrace below/above 🫡
```

#### List of samples
You can find various sample ink! smart-contracts in the `sample/` directory. For detailed descriptions of these samples and

You can find various sample ink! smart-contracts in the `sample/` directory. For detailed descriptions of these samples
and
instructions on how to instrument them for testing with Phink, please refer to the [sample's README](sample/README.md)
file.

Expand Down

0 comments on commit 0f434bd

Please sign in to comment.