Skip to content

Commit

Permalink
Update contribution docs (#120)
Browse files Browse the repository at this point in the history
# Description

Update Readme and Contribution Guidelines with better description of how
to contribute and make commits.
Also edited some formatting slightly for readability.
  • Loading branch information
itsacoyote authored Jun 11, 2024
1 parent 637d934 commit 03b0946
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 24 deletions.
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,6 @@ Run the project locally:
bun run dev
```

## Local Preview 👀

To locally preview the production build, first run `bun run build` to build the project, then run the following:

```shell
bun run preview
```

## Lint & Formatting ✨

This project provides lint commands to check the project.
Expand Down Expand Up @@ -98,8 +90,15 @@ bun run lint:eslint

We welcome contributions from the community! Check out the following resources to get started:

- [Contribution Overview](./content/00.build/90.contributing-to-documentation/10.index.md)
- [Contribution Guidelines](./content/00.build/90.contributing-to-documentation/20.contribution-guidelines.md)
- [Documentation Styleguide](./content/00.build/90.contributing-to-documentation/30.documentation-styleguide.md)
- [Contribution Overview](https://docs.zksync.io/build/contributing-to-documentation)
- To get started with the project locally and learn how to submit PRs for the project,
read the [Contribution Guidelines](https://docs.zksync.io/build/contributing-to-documentation/contribution-guidelines)
- To learn how to write your content for documentation, read the
[Documentation Styleguide](https://docs.zksync.io/build/contributing-to-documentation/documentation-styleguide)

### Check out Community Code

If you want to contribute tutorials to our Docs, check out the
[Community Code repo](https://github.com/zkSync-Community-Hub/community-code?tab=readme-ov-file#community-code)!

Join us in making zkSync Docs better for everyone! 🌐✨
Original file line number Diff line number Diff line change
Expand Up @@ -7,32 +7,44 @@ description: Learn how to contribute to zkSync Docs

Make a [fork of the zksync-docs project](https://github.com/matter-labs/zksync-docs/fork) and create your branches from the default `main` branch.

If your PR is still a work in progress, consider putting it into a [Draft status](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#converting-a-pull-request-to-a-draft).
If your PR is still a work in progress, consider putting it into a [Draft status][github-draft-status].
Once your PR is ready for review, switch it back to an active PR request
and any reviewers already attached will automatically get a notification.

[github-draft-status]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#converting-a-pull-request-to-a-draft

## Commit conventions

This project uses [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standards.
For changes that are **code related**, use the `fix:`, `feat:`, or `chore:` tags in your commits.
For typo or document related changes, please use the `docs:` tag.
For changes that are **code related**, use the `chore:`, `fix:`, `feat:`, or `docs:` tags in your commits.

- `chore` tagged commits will not create a release. Use for changes that do not directly affect the end user.
- `fix` commits will create a patch release.
- `feat` commits will create a minor release.
- `docs` commits will create a minor release. Use for typo fixes or document related changes.

```sh
git commit -m "docs: fix typo in guide"
```

### Signed git commits

Your git commits need to be [signed with a verified signature](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification).
Your git commits need to be [signed with a verified signature][github-verified-signature-commits].

1. Follow the instructions to [generate a signing key][github-generate-signing-key].
1. [Add the key to your GitHub account][github-add-key].
1. [Tell git about your signing key][github-signing-key].

1. Follow the instructions to
[generate a signing key](https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key).
1. [Add the key to your GitHub account](https://docs.github.com/en/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account).
1. [Tell git about your signing key](https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key).
[github-verified-signature-commits]: https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification
[github-generate-signing-key]: https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key
[github-add-key]: https://docs.github.com/en/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account
[github-signing-key]: https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key

## Contribution workflow

To set up and run the project locally, consult the root [`README.md`](%%zk_git_repo_zksync-docs%%?tab=readme-ov-file#-zksync-developer-documentation) file.
To set up and run the project locally, consult the root [`README.md`][project-readme] file.

[project-readme]: %%zk_git_repo_zksync-docs%%?tab=readme-ov-file#-zksync-developer-documentation

### Use VSCode

Expand Down Expand Up @@ -76,14 +88,10 @@ We use a double digit numbering scheme.
#### Using Vue Components in markdown

Vue components can be used within markdown files, although their syntax is different.
Components within markdown are identified with `::`.
Components placed in the `/components/content` are automatically imported for use in markdown files in `/content`.
Refer to the Nuxt Content page on [Vue components section](https://content.nuxt.com/usage/markdown#vue-components)
to learn how the Vue markdown syntax works.

Vue components that are not within the `/components/content` directory
need to be globally configured to use in markdown content.

### Nuxt UI

[Nuxt UI](https://ui.nuxt.com/components/) along with
Expand Down

0 comments on commit 03b0946

Please sign in to comment.