Skip to content

Commit

Permalink
[docs] add contribution guide to monorepo root (taikoxyz#228)
Browse files Browse the repository at this point in the history
  • Loading branch information
d1onys1us authored Nov 5, 2022
1 parent 319f659 commit 4a93edd
Showing 1 changed file with 23 additions and 10 deletions.
33 changes: 23 additions & 10 deletions packages/website/CONTRIBUTING.md → CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,25 @@
# Contributing
# Contribution guide

## Table of contents

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

## Coding style guide

### Source code comments

Follow the [NatSpec format](https://docs.soliditylang.org/en/v0.8.16/natspec-format.html) for documentating smart contract source code. Please adhere to a few additional standards:

- Choose `/** */` over `///` for multi-line NatSpec comments, to save column space
- Omit the usage of `@notice`, this will be automatically picked up so it will save column space and improve readability
- Take advantage of inheritance for docs (such as documenting the interface), if you need to specify inherited docs use `@inheritdoc`

### Git standards

#### Commits

Try to specify the scope of your change via a [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) (eg. `enhance(docs): improve some section`) or specifying the scope in brackets (eg. `[docs] improve some section`).

## Documentation style guide

Expand Down Expand Up @@ -79,15 +100,7 @@ Group documentation under one of the four categories:
&& echo "looks good when copy pastad"
```

#### Source code comments

In general, you should follow the [NatSpec format](https://docs.soliditylang.org/en/v0.8.16/natspec-format.html) for documentating smart contract source code. Please adhere to a few additional standards:

- Use `/** */` over `///` for multiline NatSpec comments, to save column space
- Omit the usage of `@notice`, this will be automatically picked up so it will save column space and improve readability
- Take advantage of inheritance for docs (such as documenting the interface), if you need to specify inherited docs use `@inheritdoc`

### Sources
## References

- [Diátaxis](https://diataxis.fr/)
- [Google dev docs highlights](https://developers.google.com/style/highlights)
Expand Down

0 comments on commit 4a93edd

Please sign in to comment.