Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add and update project community files #15

Merged
merged 9 commits into from
Jun 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 0 additions & 44 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: Bug Report
description: File a bug report.
title: "[Bug]: "
labels: ["bug", "triage"]
assignees:
- @zkSync-Community-Hub/zksync-devrel
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: input
id: guide
attributes:
label: Guide you're having trouble with
description: If this feature is related to a specific guide, please provide the link to the guide.
placeholder: https://code.community.com/guides/the-guide
value: ""
- 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/zkSync-Community-Hub/community-code/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: If you have any questions or need help beyond this project, please visit our Discussions page for zksync developers.
26 changes: 0 additions & 26 deletions .github/ISSUE_TEMPLATE/feature_report.md

This file was deleted.

33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Feature Request
description: Is there a feature you would like to see in Code Community? Let us know!
title: "[Feature]: "
labels: ["feature", "triage"]
assignees:
- @zkSync-Community-Hub/zksync-devrel
body:
- type: markdown
attributes:
value: |
We're constantly adding new features to the Code Community. 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 community?
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/zkSync-Community-Hub/community-code/blob/main/CODE_OF_CONDUCT.md).
options:
- label: I agree to follow this project's Code of Conduct
required: true
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/new_guide_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: New Guide Request
description: Use this form to request a guide you would like to see in Code Community.
title: "[Guide]: "
labels: ["guide", "triage"]
assignees:
- @zkSync-Community-Hub/zksync-devrel
body:
- type: markdown
attributes:
value: |
We're constantly adding new guides to the Code Community. If you have a guide 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 guide you would like to see.
placeholder: Tell us what you would like to see!
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/zkSync-Community-Hub/community-code/blob/main/CODE_OF_CONDUCT.md).
options:
- label: I agree to follow this project's Code of Conduct
required: true
33 changes: 20 additions & 13 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,24 @@
# 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 Code Community!

# 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. -->
- Read the [Contributing Guide](https://github.com/zkSync-Community-Hub/community-code/blob/main/CONTRIBUTING.md).
- Understand our [Code of Conduct](https://github.com/zkSync-Community-Hub/community-code/blob/main/CODE_OF_CONDUCT.md)

<!-- # 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
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 [email protected].
Loading
Loading