diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..9180061 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,10 @@ +# This CODEOWNERS file sets the individuals responsible for code in the zksync-hardhat-template repository. + +# These users are the default owners for everything in the repo. +# They will be requested for review when someone opens a pull request. +* @matter-labs/devxp + +# You can also specify code owners for specific directories or files. +# For example: +# /src/ @developer1 @developer2 +# /docs/ @documenter \ No newline at end of file diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..0760ce8 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,61 @@ +# Contributing to zkSync Hardhat project template + +## Warm Welcome! 🎉 + +Hello there, awesome contributor! We're delighted you're considering helping with our project. This guide is here to show you the ropes and make your contribution process smooth. + +## Starting Off + +- **Fork it.** Kick things off by forking our repository to your personal GitHub account. + +- **Get it local.** Next, let's get the project onto your computer: + + ```bash + git clone https://github.com//my-project.git + ``` + +- **Branch out.** Create a new branch, preferably with a descriptive name related to your planned contribution: + + ```bash + git checkout -b feature-or-fix-description + ``` + +## Making Your Mark + +- **Code away.** As you write, aim for clarity and simplicity. It's best for everyone. + +- **Test your code.** Before putting it out for review, ensure everything runs as expected. Here's how: + + ```bash + yarn test + ``` + +- **Commit wisely.** Opt for clear commit messages that convey the essence of your changes. + +- **Push it up.** Time to push your branch to GitHub: + + ```bash + git push origin feature-or-fix-description + ``` + +## Crafting a Pull Request + +- **Propose your changes.** Head to our repository on GitHub. There, you should spot a "Compare & pull request" button. Click it and describe what you did and why. + +- **Await our feedback.** Our team will scrutinize what you've done. Be open to potential tweaks or changes. + +Keep in mind, we run automated checks on contributions. Ensure you clear these checks before submission! + +## Need Assistance? + +Got queries or hurdles? Feel free to initiate a discussion on our [Project Community Hub](https://github.com/Project-Community-Hub/Project-Developers/discussions). We're eager to assist! + +## A Big Thank You! + +Once we integrate your changes, please know that your contribution holds immense value for us. You're helping us elevate our project. + +We sincerely hope you had a pleasant experience and consider returning for more contributions. Thank you for teaming up with us! + +--- + +*Last update: October 25, 2023* \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..1c1c911 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,45 @@ +--- +name: Bug report +about: Use this template for reporting issues +title: "" +labels: bug +assignees: '' + +--- + +### 🐛 Bug Report for zkSync Hardhat project template +#### 📝 Description + +Provide a clear and concise description of the bug. + +#### 🔄 Reproduction Steps + +1. Step 1 +2. Step 2 +3. ... + +#### 🤔 Expected Behavior + +Describe what you expected to happen. + +#### 😯 Current Behavior + +Describe what actually happened. + +#### 🖥️ Environment + +- **Package version**: [e.g., 1.2.1] +- **Node version**: [e.g., node v16.14.0] +- **NPM/Yarn version**: [e.g., npm 8.3.1] +- **Operating System & Version**: [e.g., Ubuntu 20.04] +- **Other relevant environment details**: + +#### 📋 Additional Context + +Add any other context about the problem here. If applicable, add screenshots to help explain. + +#### 📎 Log Output + +``` +Paste any relevant log output here. +``` \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..a593403 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +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. + - name: zkSync Hardhat documentation + url: https://era.zksync.io/docs/tools/hardhat/ + about: Please refer to the documentation for immediate answers. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_report.md b/.github/ISSUE_TEMPLATE/feature_report.md new file mode 100644 index 0000000..4e30b23 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_report.md @@ -0,0 +1,26 @@ +--- +name: Feature request +about: Use this template for requesting features +title: "" +labels: feat +assignees: '' + +--- + +### 🌟 Feature Request + +#### 📝 Description + +Provide a clear and concise description of the feature you'd like to see. + +#### 🤔 Rationale + +Explain why this feature is important and how it benefits the project. + +#### 🖼️ Mockups/Examples + +If applicable, provide mockups or examples of how the feature would work. + +#### 📋 Additional Context + +Add any other context or information about the feature request here. \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..8778b89 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,17 @@ +# 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 + +# Evidence :camera: +Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended + + + +# Notes :memo: +* Any notes/thoughts that the reviewers should know prior to reviewing the code? \ No newline at end of file