Skip to content

Commit

Permalink
chore: update readme and contributing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
itsacoyote committed May 29, 2024
1 parent 546d9e7 commit 303fcc5
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 34 deletions.
9 changes: 0 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,12 +91,3 @@ git commit -m "docs: description of change made in commit"
You can use `docs(fix):` for commits that make small edits instead of adding a new guide.

For project code changes that are not document related, use the `fix:` label.

## 👪 Join the community

If you haven't already, join our community!
We have [GitHub Discussions](https://github.com/zkSync-Community-Hub/zksync-developers/discussions)
for developers to ask questions and share their work.
We also have a [Discord server](https://join.zksync.dev/) for real-time conversations with the team and community.

Be sure to [follow us on Twitter](https://x.com/zkSyncDevs) to keep up to date with announcements from the zkSync dev team.
82 changes: 57 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,32 @@
# Community Code

![License](https://img.shields.io/badge/license-MIT-blue)
![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-orange)
![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-orange)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)
[![License](https://img.shields.io/badge/license-MIT-blue)](LICENSE-MIT)
[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-orange)](LICENSE-APACHE)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://www.contributor-covenant.org/)
[![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-orange)](CONTRIBUTING.md)
[![X (formerly Twitter) Follow](https://badgen.net/badge/twitter/@zksyncDevs/1DA1F2?icon&label)](https://x.com/zksyncDevs)

Welcome to the zkSync Community Code repository. This project serves as the community hub for zkSync, providing comprehensive
documentation for developers written by developers.
Whether you're a beginner looking to get started with zkSync or an experienced developer
seeking advanced guides, you'll find the resources you need here.

## Tools used
## 🚀 Quick Start

1. **Install Bun:** Follow the [installation instructions](https://bun.sh/docs/installation).
2. **Install Dependencies:**

```sh
bun install
```

3. **Run Locally:** Start the development server at `http://localhost:3000`.

```sh
bun run dev
```

## 🛠️ Built With

- [Vue](https://vuejs.org/)
- [Nuxt](https://nuxt.com/)
Expand All @@ -19,36 +35,27 @@ seeking advanced guides, you'll find the resources you need here.
- [Tailwind](https://tailwindcss.com/)
- [Bun](https://bun.sh/)

## Local Setup
## Local Preview 👀

This project uses bun to run, follow the [bun installation instructions](https://bun.sh/docs/installation). Once bun is
installed, run the following command to install all project dependencies:
To locally preview the production build, first run `bun run build` to build the project, then run the following:

```shell
bun install
bun run preview
```

## Development
## Lint & Formatting ✨

To run the project locally at `http://localhost:3000`

```shell
bun run dev -o
```
This project provides lint commands to check the project.

## Local Preview
### Run CI Checks ✔️

To locally preview the production build, first run `bun run generate` to build the project, then run the following:
This command will run all of the lint commands together.

```shell
bun run preview
bun run ci:check
```

## Lint & Formatting

This project provides lint commands to check the project.

### Markdown Linting
### Markdown Linting 📝

Markdown files are found in the `/content` directory. The following lint commands will run within that directory:

Expand All @@ -57,11 +64,36 @@ bun run lint:spelling
bun run lint:markdown
```

### Linting
### Linting 🧹

The following commands are available to run linting on the project:
The following commands are available to run code linting on the project:

```shell
bun run lint:prettier
bun run lint:eslint
```

## 📜 Conventional Commits

We follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) specification.
Make sure your commit messages adhere to these guidelines.

For documentation changes, we recommend using the "docs:" tag. For example:

```sh
git commit -m "docs: fix spelling error"
```

## 🤝 Contributions

We welcome contributions from the community!
Check out our [Contributing guide](CONTRIBUTING.md) to learn how to add your own guides to Code Community.

## 👪 Join the community

If you haven't already, join our community!
We have [GitHub Discussions](https://github.com/zkSync-Community-Hub/zksync-developers/discussions)
for developers to ask questions and share their work.
We also have a [Discord server](https://join.zksync.dev/) for real-time conversations with the team and community.

Be sure to [follow us on Twitter](https://x.com/zkSyncDevs) to keep up to date with announcements from the zkSync dev team.

0 comments on commit 303fcc5

Please sign in to comment.