From b2b75f1105210d68e31e04dd682cb6d1bdf39e28 Mon Sep 17 00:00:00 2001 From: Hardik Dava <39372750+hardikdava@users.noreply.github.com> Date: Sun, 23 Jul 2023 22:56:20 +0200 Subject: [PATCH 1/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 43acf5c8..7992316f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -32,6 +32,7 @@ When creating new functions, please ensure you have the following: 2. Unit tests for the function. 3. Examples in the documentation for the function. 4. Created an entry in our docs to autogenerate the documentation for the function. +5. Please share google colab with minimal code to test new feature or reproduce PR whenever it is possible. Please ensure that google colab can be accessed without any issue. All pull requests will be reviewed by the maintainers of the project. We will provide feedback and ask for changes if necessary. @@ -48,4 +49,4 @@ So far, **there is no types checking with mypy**. See [issue](https://github.com ## 🧪 tests -[`pytests`](https://docs.pytest.org/en/7.1.x/) is used to run our tests. \ No newline at end of file +[`pytests`](https://docs.pytest.org/en/7.1.x/) is used to run our tests. From c7c8e67ffdfeb0a1e59ce1cd0b393469a8663272 Mon Sep 17 00:00:00 2001 From: Hardik Dava <39372750+hardikdava@users.noreply.github.com> Date: Sun, 23 Jul 2023 22:56:57 +0200 Subject: [PATCH 2/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7992316f..e04d60d1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,7 +24,7 @@ Before you contribute a new feature, consider submitting an Issue to discuss the ## How to Contribute Changes -First, fork this repository to your own GitHub account. Create a new branch that describes your changes (i.e. `line-counter-docs`). Push your changes to the branch on your fork and then submit a pull request to this repository. +First, fork this repository to your own GitHub account. Create a new branch that describes your changes (i.e. `line-counter-docs`). Push your changes to the branch on your fork and then submit a pull request to `develop` branch of this repository. When creating new functions, please ensure you have the following: