Skip to content

Commit

Permalink
Fix logo (#35)
Browse files Browse the repository at this point in the history
* fix logo

* Build(deps-dev): bump the npm-development group with 6 updates (#31) (#36)

Bumps the npm-development group with 6 updates:

| Package | From | To |
| --- | --- | --- |
| [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) | `20.11.16` | `20.11.30` |
| [eslint](https://github.com/eslint/eslint) | `8.56.0` | `8.57.0` |
| [eslint-plugin-github](https://github.com/github/eslint-plugin-github) | `4.10.1` | `4.10.2` |
| [eslint-plugin-jest](https://github.com/jest-community/eslint-plugin-jest) | `27.6.3` | `27.9.0` |
| [eslint-plugin-jsonc](https://github.com/ota-meshi/eslint-plugin-jsonc) | `2.13.0` | `2.14.1` |
| [typescript](https://github.com/Microsoft/TypeScript) | `5.3.3` | `5.4.3` |


Updates `@types/node` from 20.11.16 to 20.11.30
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

Updates `eslint` from 8.56.0 to 8.57.0
- [Release notes](https://github.com/eslint/eslint/releases)
- [Changelog](https://github.com/eslint/eslint/blob/main/CHANGELOG.md)
- [Commits](eslint/eslint@v8.56.0...v8.57.0)

Updates `eslint-plugin-github` from 4.10.1 to 4.10.2
- [Release notes](https://github.com/github/eslint-plugin-github/releases)
- [Commits](github/eslint-plugin-github@v4.10.1...v4.10.2)

Updates `eslint-plugin-jest` from 27.6.3 to 27.9.0
- [Release notes](https://github.com/jest-community/eslint-plugin-jest/releases)
- [Changelog](https://github.com/jest-community/eslint-plugin-jest/blob/main/CHANGELOG.md)
- [Commits](jest-community/eslint-plugin-jest@v27.6.3...v27.9.0)

Updates `eslint-plugin-jsonc` from 2.13.0 to 2.14.1
- [Release notes](https://github.com/ota-meshi/eslint-plugin-jsonc/releases)
- [Changelog](https://github.com/ota-meshi/eslint-plugin-jsonc/blob/master/CHANGELOG.md)
- [Commits](ota-meshi/eslint-plugin-jsonc@v2.13.0...v2.14.1)

Updates `typescript` from 5.3.3 to 5.4.3
- [Release notes](https://github.com/Microsoft/TypeScript/releases)
- [Changelog](https://github.com/microsoft/TypeScript/blob/main/azure-pipelines.release.yml)
- [Commits](microsoft/TypeScript@v5.3.3...v5.4.3)

---
updated-dependencies:
- dependency-name: "@types/node"
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: npm-development
- dependency-name: eslint
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: npm-development
- dependency-name: eslint-plugin-github
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: npm-development
- dependency-name: eslint-plugin-jest
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: npm-development
- dependency-name: eslint-plugin-jsonc
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: npm-development
- dependency-name: typescript
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: npm-development
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* fix content

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
  • Loading branch information
julienbrg and dependabot[bot] authored Mar 25, 2024
1 parent b8fefe1 commit 85cf5d0
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 36 deletions.
50 changes: 15 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Pattini is a GitHub Action designed to incentivize and reward contributors of a GitHub project. When an issue is merged by a maintainer, the pull request author automatically receives a certain amount of ERC-20 (USDC, DAI, ...).

Watch video: https://youtu.be/NbGHN4nkXLY

## Install

```
Expand All @@ -20,62 +22,40 @@ npm test
npm run bundle
```

## Use

The directory owner creates an issue. At the end of the description, he adds the amount
of the reward that the contributor will receive if the branch he has created is merged.
## Use as a contributor

Example of an issue description:
When you create a branch from the issue, add your wallet address at the end of the name of the branch with a hyphen (-).

```
We need to add a /blog page where we could post some news.
Tasks:
1. Design and Layout:
- Determine the layout and design of the Blog page.
- Consider integrating it seamlessly with the existing website design.
2. Functionality:
- Implement a backend system for managing blog posts.
- Ensure proper routing/navigation to the Blog page.
Amount : 15 OP
-0x8CCbFaAe6BC02a73BBe8d6d8017cC8313E4C90A7
```

_Mandatory format:_
Your branch name should look like this example:

```
DESCRIPTION...
Amount : AMOUNT OP
15-Add-blog-page-to-website-0x8CCbFaAe6BC02a73BBe8d6d8017cC8313E4C90A7
```

When the contributor creates a branch from the issue, the name of the branch:

- **MUST** begin with the number of the corresponding issue
- **MUST** end with the contributor's wallet address
The payment will be triggered when the branch is merged to main.

### Example
Watch video: https://youtu.be/NbGHN4nkXLY

```
15-Add-blog-page-to-website-0x8CCbFaAe6BC02a73BBe8d6d8017cC8313E4C90A7
```
View a example directory that's using Pattini:
[Fables de La Fontaine](https://github.com/w3hc/fables-de-lafontaine)

_Mandatory format:_

```
<ISSUE_NUMBER>-<ISSUE_NAME>-<CONTRIBUTOR_WALLET_ADDRESS>
```

When the branch is created, the address at the end is stored on-chain so that the account receiving the reward cannot change.
## Use Pattini as a repository maintainer

Only one person will be paid per issue (the first merge for that issue).
The repository maintainer should make sure that at least 1 review is required to allow merging.

Sample directory using Pattini:
[Fables de La Fontaine](https://github.com/w3hc/fables-de-lafontaine)
Before merging, he should also verify if another no one else made a pull request before.

## Add Pattini to your project
### Config

To get Pattini up and running in your repository:

Expand Down
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ description: 'Rewards an external contributor'
author: 'W3HC'

branding:
icon: 'https://bafkreid47g4uxs5msarp3v5hvf7ssdqi3la5kylmwseirva7wzkyc5bgvi.ipfs.w3s.link/'
icon: 'pattini-logo.png'

inputs:
PRIVATE_KEY:
Expand Down
Binary file added pattini-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 85cf5d0

Please sign in to comment.