Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alextnetto authored Jul 30, 2022
1 parent 6fa3467 commit 391e6d3
Showing 1 changed file with 3 additions and 32 deletions.
35 changes: 3 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,43 +5,14 @@ Functions for generating interface ID from smart contracts following ERC-165 req

[site](https://eip165-demo.vercel.app)

[repository](https://github.com/blockful-io/erc165-example) using this lib in hardhat tests

## Setup :gear:

**install**

## **Install**

```
yarn add eip165
```
ou
or
```
npm install eip165
```

## How to start developing and testing this project :clipboard:

1. Before you start, make sure your environment is ready for NodeJS development, as per the official instructions described here. [https://nodejs.org/en/download/package-manager/](https://nodejs.org/en/download/package-manager/).
2. Clone this repository using the command ``` git clone < project-url.git > ```.
3. Install project dependencies using ``` yarn ```.

## Good habits :thumbsup:

### GIT

#### Naming the branches

Development branches must be created from the dev branch, checking out with the command `git checkout dev`.

1. If the branch is for a new feature, create it with the name `feature/branch-name` with the command `git checkout -b feature/branch-name`.
2. If the branch is from a patch, create it with the name `fix/branch-name` with the command `git checkout -b fix/branch-name`.
3. If the branch is from a release, create it with the name `release/branch-name` with the command `git checkout -b release/branch-name`.


> Remember to create the branch name in English, using the ES6 standard, with the name in lowercase and separated by a hyphen.
#### Commit pattern

The commits in Git can be done in Portuguese and describing well what the actions present in this commit. Remember to commit at least once a day. You can also do several commits to separate well what is going into the repository. Imagining a commit to fix the text of a button, you could use the command `git commit -m "fix callback"` and the commando `git push` to push code and commit to repository.

You can also commit 'broken' code to the repository, remembering to add the initials of `Work In Progress` at the beginning of the commit message, for example: `git commit -m "[WIP] fix callback"`.

0 comments on commit 391e6d3

Please sign in to comment.