Skip to content

Commit

Permalink
chore: update project docs (#97)
Browse files Browse the repository at this point in the history
- Adds a collection of markdown documents to add to our [Community
Standards](https://github.com/matter-labs/zksync-docs/community).
  - Code of Conduct doc
  - Contributing doc for getting started
  - Add cute little tags to the README
  - Add a Support doc to help users in getting support

- Adds templates for Issues that use the [Issue
forms](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms)
format
  - Bug Report issue template for reporting bugs with guides
  - Feature Report issue template for requesting new features

- Modify the Pull Request template. Simplifies the form and also adds in
some additional descriptions for the user to read before submitting.
  • Loading branch information
itsacoyote authored Jun 3, 2024
1 parent 1bca15a commit 38cb61e
Show file tree
Hide file tree
Showing 17 changed files with 399 additions and 197 deletions.
44 changes: 0 additions & 44 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Bug Report
description: File a bug report.
title: "[Bug]: "
labels: ["bug", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report! Please fill out as much as you can, the more details the better we can help to resolve the issue.
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
value: ""
validations:
required: true
- type: textarea
id: expected
attributes:
label: What did you expect to happen?
placeholder: Tell us what you expected!
value: ""
- type: textarea
id: environment
attributes:
label: Environment
description: Please share any relevant information about your environment.
placeholder: |
- Operating System: [e.g. macOS]
- Node version: [e.g., v18.17.0]
- Other relevant environment details:
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/matter-labs/zksync-docs/blob/main/CODE_OF_CONDUCT.md).
options:
- label: I agree to follow this project's Code of Conduct
required: true
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ blank_issues_enabled: true
contact_links:
- name: zksync-developers Discussion
url: https://github.com/zkSync-Community-Hub/zkync-developers/discussions
about: Please provide feedback, and ask questions here.
about: These forms are for zkSync Docs related issues. If you have questions or need help, please visit the zksync-developers Discussion.
26 changes: 0 additions & 26 deletions .github/ISSUE_TEMPLATE/feature_report.md

This file was deleted.

31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Feature Request
description: Is there a feature missing you would like to see? Let us know!
title: "[Feature]: "
labels: ["feature", "triage"]
body:
- type: markdown
attributes:
value: |
If you have a feature you'd like to see, please fill out this form.
- type: textarea
id: description
attributes:
label: Description
description: Please provide a brief description of the feature you would like to see.
placeholder: Tell us what you would like to see!
value: ""
- type: textarea
id: rationale
attributes:
label: Rationale
description: Why do you think this feature would be beneficial to the project?
placeholder: Tell us why you think this feature would be beneficial!
value: ""
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/matter-labs/zksync-docs/blob/main/CODE_OF_CONDUCT.md).
options:
- label: I agree to follow this project's Code of Conduct
required: true
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/feedback.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Feedback
description: Please share any feedback for us on our content!
title: "[Feedback]: "
labels: ["feedback", "triage"]
body:
- type: markdown
attributes:
value: |
If you have feedback on our content, please fill out this form.
- type: input
id: page
attributes:
label: Page
description: If this is related to a specific page, please provide the URL.
placeholder: https://docs.zksync.io/page
value: ""
- type: textarea
id: description
attributes:
label: Description
description: Please provide a brief description of the feedback you would like to share.
placeholder: Tell us what you would like to share!
value: ""
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/matter-labs/zksync-docs/blob/main/CODE_OF_CONDUCT.md).
options:
- label: I agree to follow this project's Code of Conduct
required: true
35 changes: 22 additions & 13 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,26 @@
# What :computer:
* First thing updated with this PR
* Second thing updated with this PR
* Third thing updated with this PR
<!--
# Why :hand:
* Reason why first thing was added to PR
* Reason why second thing was added to PR
* Reason why third thing was added to PR
Thank you for contributing to the zkSync Docs!
# Evidence :camera:
Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended
Before submitting the PR, please make sure you do the following:
<!-- All sections below are optional. You can uncomment any section applicable to your Pull Request. -->
- Update your PR title to follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
- Read the [Contributing Guide](https://github.com/matter-labs/zksync-docs/blob/main/CONTRIBUTING.md).
- Understand our [Code of Conduct](https://github.com/matter-labs/zksync-docs/blob/main/CODE_OF_CONDUCT.md)
- Please delete any unused parts of the template when submitting your PR
<!-- # Notes :memo:
* Any notes/thoughts that the reviewers should know prior to reviewing the code? -->
-->

# Description

<!-- Please describe what are the changes and what they are solving for in this PR. -->

## Linked Issues

<!-- If you have any issues this PR is related to, link them here. -->
<!--
Check out https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue
on how to automate linking a GitHub Issue to a PR.
-->

## Additional context
2 changes: 1 addition & 1 deletion .lintstagedrc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
- prettier --list-different
- eslint
'*.md':
- cspell check
- markdownlint-cli2
- cspell check
'*.{json,yml}':
- prettier --list-different
Empty file removed CHANGELOG.md
Empty file.
87 changes: 87 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
# Code of Conduct

Version: 1.1

Apache 2.0 license, derived from the Apache Foundation Code of Conduct.
Also, CC BY-SA 3.0 derived from the Mozilla Community Participation Guidelines.

Our goal is to cultivate a safe, friendly, and inclusive space that benefits all participants in the zkSync ecosystem.
This Code of Conduct outlines our shared values and expectations to help ensure that the community remains a positive and enriching environment for everyone.

## When and how to use this Code of Conduct

This is your guide for engaging as a participant in the zkSync ecosystem.
It applies to all physical and digital spaces related to zkSync.

## Expected behaviors

**Be ethical**:
We endeavor to enrich the zkSync ecosystem, while not infringing on the rights and wellbeing of others.
We also endeavor to enrich ourselves without causing harm to the zkSync community.
We do not encourage tax evasion, promoting information leaks, speculating on tokens or token prices, or otherwise breaking the law.

**Be kind and respectful**:
Treat everyone with kindness, empathy, and respect.
We all come from different backgrounds, perspectives and experiences,
so let's celebrate our differences and foster a culture of openness and understanding.
We may have strong feelings about other layer 1 and layer 2 blockchains,
but that is no reason to disparage, defame, or slander any competitor to zkSync or what other chains are doing.
Feel free to compare metrics and features, but keep to the facts and be respectful of all the builders in web3
trying to advance freedom through blockchain technology!

**Share and learn**:
Our community is a space for sharing knowledge, experiences, and ideas.
Positively contribute to discussions, offer helpful feedback,
be willing to educate others on your work and remain open to learning from others.

**Give credit**:
When sharing content or ideas that aren't your own, ensure you give proper credit to the original creator.
Plagiarism and intellectual property infringement are strictly prohibited.

**Respect privacy**:
Always seek consent before sharing personal information about yourself or others.
Respecting each other's privacy is vital to building trust within our community.

**Be inquisitive and embrace continuous improvement**:
We strive to improve from each experience, and are open to constructive criticism.
We encourage questions, and redirect them to the appropriate channel if we do not have the answer.

**Mind your language**:
Communication is key.
Use clear and considerate language in your interactions.
We aim to create a welcoming environment for users of all ages, so please avoid excessive profanity or explicit content.
Remember that zkSync community members are a diverse bunch.
English is our primary working language, but to help others where English is not their first language,
be succinct and avoid acronyms where possible.

**Stay on topic**:
While we encourage friendly conversations, please ensure your discussions remain relevant to the community's purpose.
To keep our space focused and valuable, off-topic or irrelevant content may be redirected or removed.
Specific topics that are not appropriate include offering to buy or sell any cryptocurrency or engage in price speculation.

**No hate speech or harassment**:
Let's maintain a constructive and uplifting atmosphere in all interactions.
We have a zero-tolerance policy for any form of hate speech, bullying, harassment, or discrimination.
This includes, but is not limited to:

- Violent threats or language directed against another person.
- Sexist, racist, or otherwise discriminatory jokes and language.
- Posting sexually explicit or violent material.
- Posting (or threatening to post) other people's personally identifying information ("doxing").
- Sharing private content without explicit consent, such as messages sent privately or non-publicly.
- Personal insults.
- Unwelcome sexual attention.
- Excessive or unnecessary profanity.
- Repeated harassment of others. In general, if someone asks you to stop, then stop.
- Advocating for, or encouraging, any of the above behavior.

**Have fun and connect**:
Finally, remember that ZK Squad and the zkSync community is a place to connect, learn, and enjoy.
Participate in a manner that encourages positive interactions and enhances the experiences of all.

## Managing violations

If you come across inappropriate content or behavior, please report it without delay.
By working together, we can maintain a positive and safe environment.

If you are the subject of, or witness to, any violations of this Code of Conduct, please contact us at community@zksync.io.
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Contributing

Our primary contributing documentation is available on our site at [Contribution Guidelines](https://docs.zksync.io/build/contributing-to-documentation).
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# 🌟 zkSync Developer Documentation

![Build Status](https://img.shields.io/badge/build-passing-brightgreen)
![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)
[![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 Docs** repository! This is your go-to hub for all things
zkSync. Dive into our comprehensive documentation whether you're just starting out or looking for advanced guides.
Expand All @@ -29,7 +30,7 @@ Unlock the full potential of zkSync with our comprehensive resources:

- **🛠️ Build:** Learn how to develop and deploy your smart contracts and
applications on zkSync Era. Our step-by-step guides and tutorials will help you get started quickly and efficiently.

- **🔗 ZK Stack:** Dive into the Zero-Knowledge (ZK) Stack to discover how to
configure and build a ZK chain tailored for your application. Explore the architecture, components, and best practices.

Expand Down Expand Up @@ -93,11 +94,6 @@ 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.

## 🤝 Contributions

We welcome contributions from the community! Check out the following resources to get started:
Expand Down
31 changes: 31 additions & 0 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Support

Are you having trouble with our documentation or having some issues with a guide?
We have multiple channels available for you to request help.

## Where to get help

If you're in need of help with authoring your content for zkSync Docs,
first read through the [Contribution Guidelines](https://docs.zksync.io/build/contributing-to-documentation/contribution-guidelines)
to see if it may help answer some questions.
If the content there does not solve your problem, submit an [issue in GitHub](https://github.com/matter-labs/zksync-docs/issues)
and we can try to help resolve the issue.

### Help with developer related issues
If you are referencing the documentation for a project as a developer and run into issues,
you can go to the [zksync-developers Discussions](https://github.com/zkSync-Community-Hub/zksync-developers/discussions)
where you can submit a question. We also have a [Discord community](https://join.zksync.dev/)
that may help with any troubleshooting.

If you have questions related to any of our zkSync tools,
we recommend that you submit an Issue related to that project.
You can find the list of our open-source repositories in the [Contribution Track](https://docs.zksync.io/build/resources/contribution-track)
on our zkSync Docs site.

## 🪲 Submit a bug report

Have you come across a bug while going through our documentation?
Perhaps the versions are out of date or a particular tool is broken when trying to run a project.
Submit an [issue in GitHub](https://github.com/matter-labs/zksync-docs/issues) using our Bug Issue form
or submit feedback directly from the page! In the right sidebar on the site, there is a link below the Table of Contents
for "Share feedback" which will set up a pre-filled Issue form for the page you're on.
Loading

0 comments on commit 38cb61e

Please sign in to comment.