Skip to content

Commit

Permalink
refactor
Browse files Browse the repository at this point in the history
  • Loading branch information
dionysuzx committed Dec 14, 2022
1 parent 8a80235 commit 35edd3d
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 4 deletions.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
1. [Issue guide](#issue-guide)
2. [Coding style guide](#coding-style-guide)
3. [Documentation style guide](#documentation-style-guide)
4. [Git workflow](#git-workflow)

## Issue guide

Expand Down Expand Up @@ -113,6 +114,16 @@ Group documentation under one of the four categories:
&& echo "looks good when copy pastad"
```

## Git workflow

### Submitting a PR

Please make sure to use a conventional commit in your PR title (eg. `feat(scope): description of feature`). This will be squashed and merged into the `main` branch.

### 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.

## References

- [Diátaxis](https://diataxis.fr/)
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@

</div>

## Documentation

Most documentation can be found on the website, at [taiko.xyz](https://taiko.xyz). There should also be a README in each package, as well as comments in the source code.

## Project structure

<pre>
Expand All @@ -47,10 +51,6 @@ taiko-mono
...
</pre>

## 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.

## Contributors ✨

Thanks goes to these wonderful people! If you would like to contribute, please read the [Contributing guide](./CONTRIBUTING.md). You can also reach out to the community on [Discord](https://discord.gg/taikoxyz).
Expand Down

0 comments on commit 35edd3d

Please sign in to comment.