Skip to content

Commit

Permalink
chore: add and update project community files
Browse files Browse the repository at this point in the history
  • Loading branch information
itsacoyote committed May 29, 2024
1 parent 0e745a8 commit 0f052a1
Show file tree
Hide file tree
Showing 16 changed files with 604 additions and 124 deletions.
44 changes: 0 additions & 44 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
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: 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: what-happened
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.

40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
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: 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: 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
77 changes: 77 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@

# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[INSERT CONTACT METHOD].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
Loading

0 comments on commit 0f052a1

Please sign in to comment.