Skip to content

Commit

Permalink
chore(repo): update contributor workflow and content guide (#13479)
Browse files Browse the repository at this point in the history
  • Loading branch information
dionysuzx authored Mar 28, 2023
1 parent 08b26d2 commit dfa3070
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 11 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Bug report 🐛
description: Report a bug
title: "fix: INSERT_DESCRIPTIVE_TITLE"
title: "fix: <insert descriptive title here>"
labels: ["bug", "triage"]
body:
- type: markdown
Expand Down
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
contact_links:
- name: Community support
url: https://discord.gg/taikoxyz
about: This issue tracker is only for feature requests and bug reports. Community support is available on Discord!
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Feature request 💡
description: Request a feature
title: "feat: INSERT_DESCRIPTIVE_TITLE"
title: "feat: <insert descriptive title here>"
labels: ["feat", "triage"]
body:
- type: markdown
Expand Down
21 changes: 12 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

Here are some ways you can contribute:

- Open a new issue [here](https://github.com/taikoxyz/taiko-mono/issues).
- Open a new issue [here](https://github.com/taikoxyz/taiko-mono/issues) (please check the issue does not already exist).
- Work on an existing issue (check out the [good first issues list](https://github.com/taikoxyz/taiko-mono/labels/good%20first%20issue)).

> Check out the [coding standards](#coding-standards) and [documentation standards](#documentation-standards) before you start working on a pull request.
Expand All @@ -26,9 +26,11 @@ After your pull request is merged, a bot will automatically leave a comment with

### Pull requests

Specify the scope of your change with a [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) in the PR title (for example, `feat(scope): description of feature`). This will be squashed and merged into the `main` branch.
Specify the scope of your change with a [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) in the PR title (for example, `feat(scope): description of feature`). This will be squashed and merged into the `main` branch. You can find the full list of allowed scopes [here](https://github.com/taikoxyz/taiko-mono/blob/main/.github/workflows/lint-pr.yml#L19).

Because we squash all of the changes into a single commit, please try to keep the PR limited to the scope specified in the commit message. This commit message will end up in the automated changelog by checking which packages are affected by the commit. For example, `feat(scope): description of feature` should only impact the `scope` package. If your change is a global one, you can use `feat: description of feature`, for example.
Because we squash all of the changes into a single commit, please try to keep the PR limited to the scope specified in the commit message. This commit message will end up in the automated changelog by checking which packages are affected by the commit.

For example, `feat(scope): description of feature` should only impact the `scope` package. If your change is a global one, you can use `feat: description of feature`, for example.

### Source code comments

Expand All @@ -40,7 +42,7 @@ Follow the [NatSpec format](https://docs.soliditylang.org/en/latest/natspec-form

# Documentation standards

Use the [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/) as a base point of reference.
Use the [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/) as a base point of reference for writing style.

### Philosophy

Expand All @@ -52,12 +54,13 @@ Use the [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-

Group documentation under one of the four categories (adopted from [Diátaxis](https://diataxis.fr/)):

- How to
- Concepts
- Tutorials
- Guides
- Reference
- Resources

### Creating content

### Images
If you are interested in creating some content (video, blog post, tweet thread, visuals, etc.), you are absolutely free to do so. It's useful to get a peer review on these, if you need a peer review please reach out to the community / team on the [Taiko Discord](https://discord.gg/taikoxyz).

- Use SVG files or crushed PNG images.
- Provide alt text.
If you are looking for some more guidance on creating content, you can consult the [Taiko content guide](https://hackmd.io/@taikolabs/BJurgF1bn).

0 comments on commit dfa3070

Please sign in to comment.