Skip to content

Commit

Permalink
chore: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
omdxp committed Oct 28, 2022
1 parent 5666656 commit dabe0cd
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
5 changes: 2 additions & 3 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
# Contributing

Contributions are always welcome. Before contributing please read the
[code of conduct](https://github.com/dzcode-io/leblad/blob/master/.github/CODE_OF_CONDUCT.md) &
[code of conduct](CODE_OF_CONDUCT.md) &
[search the issue tracker](https://github.com/omdxp/leblad-go/issues); your issue
may have already been discussed or fixed in `develop`. To contribute:
may have already been discussed or fixed in `develop`. To contribute:

- Fork [leblad-go](https://github.com/omdxp/leblad-go) repository (see: [How to fork a repository on Github](https://help.github.com/articles/fork-a-repo/)).
- Install modules (run `go mod tidy`).
- Do your magic :smiley:, and please make sure that all tests are passing (run `go test -v ./...`)
- Commit your changes (we would be supper happy if you use [commitzen](https://egghead.io/lessons/javascript-writing-conventional-commits-with-commitizen)).
- [Send a pull request](https://help.github.com/articles/using-pull-requests/) and point it to `main` branch.
Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -441,3 +441,11 @@ if err != nil {
panic(err)
}
```

## Contributing

Contributions are welcome, please read the [contributing guide](.github/CONTRIBUTING.md) for more information.

## License

[MIT](LICENSE)

0 comments on commit dabe0cd

Please sign in to comment.