Skip to content

Commit

Permalink
enhance(docs): reference contributing guide from readme and update to…
Browse files Browse the repository at this point in the history
… include guidance on issues (taikoxyz#269)
  • Loading branch information
d1onys1us authored Nov 15, 2022
1 parent 134cd5a commit 5b21461
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
17 changes: 15 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,21 @@

## Table of contents

1. [Coding style guide](#coding-style-guide)
2. [Documentation style guide](#documentation-style-guide)
1. [Issue guide](#issue-guide)
2. [Coding style guide](#coding-style-guide)
3. [Documentation style guide](#documentation-style-guide)

## Issue guide

As an open source project, you are free to open issues and work on issues. Please comment on the issue discussion if you are thinking of contributing or picking something up, so as to not overlap on any work.

### Finding an issue to work on

If you are looking for a good issue to start with, look for issues tagged with "good first issue".

### Opening a new issue

If you are opening a new issue, try to be descriptive as possible. Also please check if an existing issue already exists for it already.

## Coding style guide

Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,14 @@

- [branding](./packages/branding/): branding materials
- [protocol](./packages/protocol/): L1 and L2 smart contracts
- [relayer](./packages/relayer/): bridge relayer
- [website](./packages/website/): main documentation website
- [whitepaper](./packages/whitepaper): Latex source files for Taiko's whitepaper. A PDF will be published automatically to: https://taikochain.github.io/taiko-mono/taiko-whitepaper.pdf (linked from https://taiko.xyz).

## Contributing

Refer to the [Contribution guide](./CONTRIBUTING.md) to contribute.

## Github Actions

Each commit will automatically trigger the GitHub Actions to run. If any commit message in your push or the HEAD commit of your PR contains the strings [skip ci], [ci skip], [no ci], [skip actions], or [actions skip] workflows triggered on the push or pull_request events will be skipped.
Expand Down

0 comments on commit 5b21461

Please sign in to comment.