diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2e3d1fef1a..6fc69b3cc9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/README.md b/README.md index f47a0de7ca..7ee220fc4f 100644 --- a/README.md +++ b/README.md @@ -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.