From 0c723253877acfdbe868cce5e942c3cd9133f600 Mon Sep 17 00:00:00 2001 From: itz-Me-Pj <155612188+itz-Me-Pj@users.noreply.github.com> Date: Tue, 30 Jan 2024 11:31:47 +0000 Subject: [PATCH 1/6] Contributing markdown Refresh --- CONTRIBUTING.md | 42 ++++++++++++++++++++++++++++++++---------- 1 file changed, 32 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bd38d09620..8b0953f19b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,18 +8,40 @@ Before opening an issue, please search the [issue tracker](https://github.com/re Please ask any general and implementation specific questions on [Stack Overflow with a Redux Toolkit tag](http://stackoverflow.com/questions/tagged/redux-toolkit?sort=votes&pageSize=50) for support. -## New Features +We ask you to do this because StackOverflow has a much better job at keeping popular questions visible. Unfortunately good answers get lost and outdated on GitHub. -Please open an issue with a proposal for a new feature or refactoring before starting on the work. We don't want you to waste your efforts on a pull request that we won't want to accept. +Some questions take a long time to get an answer. If your question gets closed or you don't get a reply on StackOverflow for longer than a few days, we encourage you to post an issue linking to your question. We will close your issue but this will give people watching the repo an opportunity to see your question and reply to it on StackOverflow if they know the answer. + +Please be considerate when doing this as this is not the primary purpose of the issue tracker. + +### Help Us Help You + +On both websites, it is a good idea to structure your code and question in a way that is easy to read to entice people to answer it. For example, we encourage you to use syntax highlighting, indentation, and split text in paragraphs. + +Please keep in mind that people spend their free time trying to help you. You can make it easier for them if you provide versions of the relevant libraries and a runnable small project reproducing your issue. You can put your code on [JSBin](https://jsbin.com) or, for bigger projects, on GitHub. Make sure all the necessary dependencies are declared in `package.json` so anyone can run `npm install && npm start` and reproduce your issue. ## Getting started Visit the [Issue tracker](https://github.com/reduxjs/redux-toolkit/issues) to find a list of open issues that need attention. +### Bugs and Improvements + +We use the [Issue tracker](https://github.com/reduxjs/redux-toolkit/issues) to keep track of bugs and improvements to redux-toolkit itself, its examples, and the documentation. We encourage you to open issues to discuss improvements, architecture, theory, internal implementation, etc. If a topic has been discussed before, we will ask you to join the previous discussion. + +### New Features + +Please open an [issue](https://github.com/reduxjs/redux-toolkit/issues) with a proposal for a new feature or refactoring before starting on the work. We don't want you to waste your efforts on a pull request that we won't want to accept. + ### Fork the repository Please use the GitHub UI to [fork this repository](https://github.com/reduxjs/redux-toolkit) (_read more about [Forking a repository](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo)_). Redux Toolkit has forked builds enabled in the CI, so you will see the build status of your fork's branch. +Fork, then clone the repo: + +```sh +git clone https://github.com/your-username/redux-toolkit.git +``` + ### Install ```bash @@ -27,6 +49,14 @@ $ cd redux-toolkit $ yarn ``` +### Build + +You can build the packages with the following command: + +``` +yarn build +``` + ### Tests You can run tests for all packages with: @@ -41,14 +71,6 @@ To continuously watch and run tests, run the following: yarn test --watch ``` -### Build - -You can build the packages with the following command: - -``` -yarn build -``` - ## Git workflow / Submitting Changes - Open a new issue in the [Issue tracker](https://github.com/reduxjs/redux-toolkit/issues). From 573c650506a891e8f38718f083d87ac5c248b51e Mon Sep 17 00:00:00 2001 From: itz-Me-Pj <155612188+itz-Me-Pj@users.noreply.github.com> Date: Tue, 30 Jan 2024 17:20:06 +0530 Subject: [PATCH 2/6] Added Forking Example Added forking example image URL --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8b0953f19b..c43195706b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,6 +36,8 @@ Please open an [issue](https://github.com/reduxjs/redux-toolkit/issues) with a p Please use the GitHub UI to [fork this repository](https://github.com/reduxjs/redux-toolkit) (_read more about [Forking a repository](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo)_). Redux Toolkit has forked builds enabled in the CI, so you will see the build status of your fork's branch. +![Fork Button](https://docs.github.com/assets/cb-40742/mw-1440/images/help/repository/fork-button.webp) + Fork, then clone the repo: ```sh From 4162bd1e741fc9cd4e3616ed129cdbc25bf96329 Mon Sep 17 00:00:00 2001 From: itz-Me-Pj <155612188+itz-Me-Pj@users.noreply.github.com> Date: Tue, 30 Jan 2024 17:42:10 +0530 Subject: [PATCH 3/6] Updated Readme to Include Contribution Guide Added contribution guide link to the readme --- packages/toolkit/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/packages/toolkit/README.md b/packages/toolkit/README.md index 40c1239490..c81bc176bc 100644 --- a/packages/toolkit/README.md +++ b/packages/toolkit/README.md @@ -48,6 +48,10 @@ The Redux Toolkit docs are available at **https://redux-toolkit.js.org**, includ The Redux core docs at https://redux.js.org includes the full Redux tutorials, as well usage guides on general Redux patterns. +## Contributing + +Pls refer to our [contributing guide](/CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Redux-toolkit. + ## Purpose The **Redux Toolkit** package is intended to be the standard way to write Redux logic. It was originally created to help address three common concerns about Redux: From 1f94c9c21ccfa975524b01d81043c8c152494c4d Mon Sep 17 00:00:00 2001 From: itz-Me-Pj <155612188+itz-Me-Pj@users.noreply.github.com> Date: Wed, 31 Jan 2024 00:29:06 +0000 Subject: [PATCH 4/6] Updated contribution doc with the chaCges requested --- CONTRIBUTING.md | 8 +++----- packages/toolkit/README.md | 2 +- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c43195706b..991f1274fe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,13 +10,11 @@ Please ask any general and implementation specific questions on [Stack Overflow We ask you to do this because StackOverflow has a much better job at keeping popular questions visible. Unfortunately good answers get lost and outdated on GitHub. -Some questions take a long time to get an answer. If your question gets closed or you don't get a reply on StackOverflow for longer than a few days, we encourage you to post an issue linking to your question. We will close your issue but this will give people watching the repo an opportunity to see your question and reply to it on StackOverflow if they know the answer. - -Please be considerate when doing this as this is not the primary purpose of the issue tracker. +If your question gets closed or you don't get a reply after a few days, consider opening a [discussion](https://github.com/reduxjs/redux-toolkit/discussions) or joining the [Reactiflux](https://discord.gg/reactiflux) discord server and asking in the #redux channel. ### Help Us Help You -On both websites, it is a good idea to structure your code and question in a way that is easy to read to entice people to answer it. For example, we encourage you to use syntax highlighting, indentation, and split text in paragraphs. +On both websites, it is a good idea to structure your code and question in a way that is easy to read to help people to answer it. For example, we encourage you to use syntax highlighting, indentation, and split text in paragraphs. Please keep in mind that people spend their free time trying to help you. You can make it easier for them if you provide versions of the relevant libraries and a runnable small project reproducing your issue. You can put your code on [JSBin](https://jsbin.com) or, for bigger projects, on GitHub. Make sure all the necessary dependencies are declared in `package.json` so anyone can run `npm install && npm start` and reproduce your issue. @@ -26,7 +24,7 @@ Visit the [Issue tracker](https://github.com/reduxjs/redux-toolkit/issues) to fi ### Bugs and Improvements -We use the [Issue tracker](https://github.com/reduxjs/redux-toolkit/issues) to keep track of bugs and improvements to redux-toolkit itself, its examples, and the documentation. We encourage you to open issues to discuss improvements, architecture, theory, internal implementation, etc. If a topic has been discussed before, we will ask you to join the previous discussion. +We use the [Issue tracker](https://github.com/reduxjs/redux-toolkit/issues) to keep track of bugs and improvements to Redux Toolkit itself, its examples, and the documentation. We encourage you to open issues to discuss improvements, architecture, theory, internal implementation, etc. If a topic has been discussed before, we will ask you to join the previous discussion. ### New Features diff --git a/packages/toolkit/README.md b/packages/toolkit/README.md index c81bc176bc..b6cd0a547a 100644 --- a/packages/toolkit/README.md +++ b/packages/toolkit/README.md @@ -50,7 +50,7 @@ The Redux core docs at https://redux.js.org includes the full Redux tutorials, a ## Contributing -Pls refer to our [contributing guide](/CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Redux-toolkit. +Please refer to our [contributing guide](/CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Redux Toolkit. ## Purpose From 2e75f87f8e4dd609d4c7af9e5150a816b177cbae Mon Sep 17 00:00:00 2001 From: itz-Me-Pj <155612188+itz-Me-Pj@users.noreply.github.com> Date: Thu, 1 Feb 2024 06:04:51 +0530 Subject: [PATCH 5/6] Update README.md Moved Contribution Section to the bottom --- packages/toolkit/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/toolkit/README.md b/packages/toolkit/README.md index b6cd0a547a..a2514f3e10 100644 --- a/packages/toolkit/README.md +++ b/packages/toolkit/README.md @@ -48,10 +48,6 @@ The Redux Toolkit docs are available at **https://redux-toolkit.js.org**, includ The Redux core docs at https://redux.js.org includes the full Redux tutorials, as well usage guides on general Redux patterns. -## Contributing - -Please refer to our [contributing guide](/CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Redux Toolkit. - ## Purpose The **Redux Toolkit** package is intended to be the standard way to write Redux logic. It was originally created to help address three common concerns about Redux: @@ -108,3 +104,7 @@ RTK Query includes these APIs: - `setupListeners()`: A utility used to enable refetchOnMount and refetchOnReconnect behaviors. See the [**RTK Query Overview**](https://redux-toolkit.js.org/rtk-query/overview) page for more details on what RTK Query is, what problems it solves, and how to use it. + +## Contributing + +Please refer to our [contributing guide](/CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Redux Toolkit. From 942c80f0c00b6d883145c7e354bfb2f44e3d474e Mon Sep 17 00:00:00 2001 From: itz-Me-Pj <155612188+itz-Me-Pj@users.noreply.github.com> Date: Sat, 3 Feb 2024 00:31:50 +0530 Subject: [PATCH 6/6] Update CONTRIBUTING.md suggesting ways to contribute --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 991f1274fe..d0d510dc68 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,6 +18,10 @@ On both websites, it is a good idea to structure your code and question in a way Please keep in mind that people spend their free time trying to help you. You can make it easier for them if you provide versions of the relevant libraries and a runnable small project reproducing your issue. You can put your code on [JSBin](https://jsbin.com) or, for bigger projects, on GitHub. Make sure all the necessary dependencies are declared in `package.json` so anyone can run `npm install && npm start` and reproduce your issue. +## Ways You Can Contribute + +There are several ways you can contribute to the repository. Instead of developing a feature or fixing a bug, you can also contribute by updating or writing [documentation](https://github.com/reduxjs/redux-toolkit/tree/master/docs) for a specific feature or implementation if you know you are good with documentation. Alternatively, you can add [examples](https://github.com/reduxjs/redux-toolkit/tree/master/examples) of any 3rd party implementation like GraphQL or React (just an example) that would help users to understand and easily integrate Redux Toolkit with that specific framework and library. + ## Getting started Visit the [Issue tracker](https://github.com/reduxjs/redux-toolkit/issues) to find a list of open issues that need attention.