From 0df94fff23b0c2e1efd6eb04edd2f7b11c0f508d Mon Sep 17 00:00:00 2001 From: Adrian Pilarczyk Date: Mon, 17 Mar 2025 13:10:34 +0100 Subject: [PATCH 1/3] Update CONTRIBUTING.md, PULL_REQUEST_TEMPLATE.md, and feature_request.yml --- .github/CONTRIBUTING.md | 15 +++++---------- .github/ISSUE_TEMPLATE/feature_request.yml | 9 ++++++++- .github/PULL_REQUEST_TEMPLATE.md | 2 ++ 3 files changed, 15 insertions(+), 11 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 7be6f8d576e..3ab84718e9c 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -16,15 +16,9 @@ To get an overview of the project, read the [README](../README.md). Here are som ## Getting started -### Issues +We love your contributions and do our best to provide you with mentorship and support. If you are looking for an issue to tackle, take a look at issues labeled [`Good first issue`](https://github.com/saleor/saleor-dashboard/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+) and [`Help wanted`](https://github.com/saleor/saleor-dashboard/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22). -#### Create a new issue - -If you spot a problem with the dashboard, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form. - -#### Solve an issue - -Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. If you find an issue to work on, you are welcome to open a PR with a fix. +If nothing grabs your attention, check [our roadmap](https://saleor.io/roadmap) or [start a Discord discussion](https://saleor.io/discord) about a feature you'd like to see. Make sure to read our [Contribution Guidelines](http://docs.saleor.io/developer/community/contributing) before opening a PR or issue. ### Make changes locally @@ -52,12 +46,13 @@ When you're finished with the changes, create a pull request, also known as a PR - Try to respect **SOLID** rules. ### Changesets + Remember to add changeset file by running `npm run change:add` command. The prompt will ask you what kind of change you have made. Please pick the one according to the following guide: + - `minor` - any breaking changes, UI updates, new features, anything that changes behavior of the app, and can be considered as minor change - `patch` - all bugfixes, insignificant UI updates (color of a button, margins, paddings, borders etc.), text typos, translation amends, CI scripts - ### Continuous Integration We run a series of automated checks on your PR to ensure that it meets our standards. If you are not sure why your PR is failing, please reach out to us. Common problems include: @@ -66,6 +61,6 @@ We run a series of automated checks on your PR to ensure that it meets our stand - UI tests are pending - reach out to maintainers to approve them - MacawUI migration check is failing - we are on the way to migrate to new MacawUI components, use imports from `@saleor/macaw-ui-next` instead of `@saleor/macaw-ui` in your changes -### Your PR is merged! +### Your PR is merged Congratulations 🎉🎉 Thank you for contribution to dashboard ✨. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index ab12beff379..507ac1bc8fe 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -14,6 +14,14 @@ body: We can implement datagrid table that presents all variants, and when clicking in some cell, it will turn into edit mode. validations: required: true + - type: input + id: discord-discussion + attributes: + label: Discord Discussion Link + description: Link to a corresponding thread in the [Discord](https://saleor.io/discord)'s "#ideas" channel. Read more about the process in the [Contribution Guidelines](http://docs.saleor.io/developer/community/contributing#contributing-issues). + placeholder: https://discord.com/channels/8640668198... + validations: + required: true - type: textarea id: acceptable-criteria attributes: @@ -39,4 +47,3 @@ body: ... validations: required: false - diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 646da0c93b9..d6aafdd5db4 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,3 +1,5 @@ ## Scope of the change + + From 7198365866e6d6274423165f8a82cb9ea9ed1db6 Mon Sep 17 00:00:00 2001 From: Adrian Pilarczyk Date: Mon, 17 Mar 2025 14:08:15 +0100 Subject: [PATCH 2/3] Update CONTRIBUTING.md to enhance clarity and emphasize contribution guidelines --- .github/CONTRIBUTING.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 3ab84718e9c..843ad50b8d8 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,11 +1,12 @@ -# Welcome to dashboard contribution guide +--- +title: Contributing +--- -Thank you for investing your time in contributing to our project! +> [!IMPORTANT] +> We value your contributions to Saleor and want to ensure they meet our project's needs. To help us maintain quality and consistency, we ask that you follow the process described in our [Contribution Guidelines](http://docs.saleor.io/developer/community/contributing). We welcome issues, new features, documentation improvements, community support, and more. Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable. -In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. - ## New contributor guide To get an overview of the project, read the [README](../README.md). Here are some resources to help you get started with open source contributions: From 6e33f2a6439c5245a3f0fc4eb89417e13210f29b Mon Sep 17 00:00:00 2001 From: Adrian Pilarczyk Date: Mon, 17 Mar 2025 14:23:07 +0100 Subject: [PATCH 3/3] fix --- .github/CONTRIBUTING.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 843ad50b8d8..38dd57ef122 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,6 +1,4 @@ ---- -title: Contributing ---- +# Welcome to dashboard contribution guide > [!IMPORTANT] > We value your contributions to Saleor and want to ensure they meet our project's needs. To help us maintain quality and consistency, we ask that you follow the process described in our [Contribution Guidelines](http://docs.saleor.io/developer/community/contributing). We welcome issues, new features, documentation improvements, community support, and more.