From ce9ac49c477796ea0f79d9311d9c7b45988eee39 Mon Sep 17 00:00:00 2001 From: Ross Barnowski Date: Tue, 25 Nov 2025 10:58:17 -0800 Subject: [PATCH 1/5] Split history site/contributing.md to CONTRIBUTING.md --- site/contributing.md => CONTRIBUTING.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename site/contributing.md => CONTRIBUTING.md (100%) diff --git a/site/contributing.md b/CONTRIBUTING.md similarity index 100% rename from site/contributing.md rename to CONTRIBUTING.md From 6d5b6cf39fd8dfc865ff3af4ffcb8101c1a642e2 Mon Sep 17 00:00:00 2001 From: Ross Barnowski Date: Tue, 25 Nov 2025 10:58:17 -0800 Subject: [PATCH 2/5] Split history site/contributing.md to CONTRIBUTING.md --- site/contributing.md => temp | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename site/contributing.md => temp (100%) diff --git a/site/contributing.md b/temp similarity index 100% rename from site/contributing.md rename to temp From 6572768f73f4c3b9b9662e608bcdef7e00d10064 Mon Sep 17 00:00:00 2001 From: Ross Barnowski Date: Tue, 25 Nov 2025 10:58:17 -0800 Subject: [PATCH 3/5] Split history site/contributing.md to CONTRIBUTING.md --- temp => site/contributing.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename temp => site/contributing.md (100%) diff --git a/temp b/site/contributing.md similarity index 100% rename from temp rename to site/contributing.md From 05b892a4208f7b0d3c6a4c28cafc3a9610fbbe4b Mon Sep 17 00:00:00 2001 From: Ross Barnowski Date: Tue, 25 Nov 2025 11:00:22 -0800 Subject: [PATCH 4/5] MAINT: {include} contributing content in site. --- site/contributing.md | 117 +------------------------------------------ 1 file changed, 1 insertion(+), 116 deletions(-) diff --git a/site/contributing.md b/site/contributing.md index 13ed7d44..78caf34e 100644 --- a/site/contributing.md +++ b/site/contributing.md @@ -1,117 +1,2 @@ -# Contributing - -We very much welcome contributions! If you have an idea or proposal for a new -tutorial, please [open an issue](https://github.com/numpy/numpy-tutorials/issues) -with an outline. - -Don’t worry if English is not your first language, or if you can only come up -with a rough draft. Open source is a community effort. Do your best – we’ll help -fix issues. - -Images and real-life data make text more engaging and powerful, but be sure what -you use is appropriately licensed and available. Here again, even a rough idea -for artwork can be polished by others. - -## Building the website - -```{note} -The NumPy tutorials are powered by [`jupyter-book`][jb-docs] and the -[`MyST` document engine][mystmd]. -See the linked documentation for further details. +```{include} ../CONTRIBUTING.md ``` - -[jb-docs]: https://jupyterbook.org/stable/ -[mystmd]: https://mystmd.org/ - -### Quickstart - -Set up a development environment with the dependencies listed in -`requirements.txt` and `site/requirements.txt`. -For example, using the built-in [`venv`][venv] module: - -```bash -python -m venv np-tutorials -source np-tutorials/bin/activate -python -m pip install -r requirements.txt -r site/requirements.txt -``` - -[venv]: https://docs.python.org/3/library/venv.html - -The site can then be built with: - -```bash -jupyter-book start --execute -``` - -This will execute all the notebooks and start a web server to view the rendered -content locally. -View the rendered site by opening the ``localhost:30xy`` in your preferred browser (the exact port number will be printed in your terminal). - -## Adding your own tutorials - -If you have your own tutorial in the form of a Jupyter notebook (an `.ipynb` -file) and you'd like to try add it out to the repository, follow the steps below. - -### Create an issue - -Go to and create a new issue -with your proposal. -Give as much detail as you can about what kind of content you would like to -write (tutorial, how-to) and what you plan to cover. -We will try to respond as quickly as possible with comments, if applicable. - -### Check out our suggested template - -You can use this template to make your content consistent with our existing -tutorials. - -### Upload your content - -Remember to clear all outputs on your notebook before uploading it. - -
    -
    - - Fork this repository (if you haven't before). - - -
    - -
    - - In your own fork, create a new branch for your content. - - -
    - -
    - - Add your notebook to the content/ directory. - - -
    - -Update the environment.yml file with the dependencies for your tutorial -(only if you add new dependencies). - -
    - - Update this README.md to include your new entry. - - -
    - -
    - - Create a pull request. Make sure the "Allow edits and access to secrets by maintainers" option is selected so we can properly review your submission. - - -
    - -🎉 Wait for review! -
- -For more information about GitHub and its workflow, you can see -[this document][collab]. - -[collab]: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests From 677b126e4816923ffc5f072b2b094976632f94e3 Mon Sep 17 00:00:00 2001 From: Ross Barnowski Date: Tue, 25 Nov 2025 12:19:58 -0800 Subject: [PATCH 5/5] MAINT: Rm duplicated contributing info from README. --- README.md | 135 ------------------------------------------------------ 1 file changed, 135 deletions(-) diff --git a/README.md b/README.md index 0209e32b..5109e2c9 100644 --- a/README.md +++ b/README.md @@ -25,141 +25,6 @@ or navigate to any of the documents listed below and download it individually. 8. [Tutorial: Plotting Fractals](content/tutorial-plotting-fractals.ipynb) 9. [Tutorial: Analysing the impact of the lockdown on air quality in Delhi, India](content/tutorial-air-quality-analysis.md) - -## Contributing - -We very much welcome contributions! If you have an idea or proposal for a new -tutorial, please [open an issue](https://github.com/numpy/numpy-tutorials/issues) -with an outline. - -Don’t worry if English is not your first language, or if you can only come up -with a rough draft. Open source is a community effort. Do your best – we’ll help -fix issues. - -Images and real-life data make text more engaging and powerful, but be sure what -you use is appropriately licensed and available. Here again, even a rough idea -for artwork can be polished by others. - -### Building the website - -```{note} -The NumPy tutorials are powered by [`jupyter-book`][jb-docs] and the -[`MyST` document engine][mystmd]. -See the linked documentation for further details. -``` - -[jb-docs]: https://jupyterbook.org/stable/ -[mystmd]: https://mystmd.org/ - -#### Quickstart - -Set up a development environment with the dependencies listed in -`requirements.txt` and `site/requirements.txt`. -For example, using the built-in [`venv`][venv] module: - -```bash -python -m venv np-tutorials -source np-tutorials/bin/activate -python -m pip install -r requirements.txt -r site/requirements.txt -``` - -[venv]: https://docs.python.org/3/library/venv.html - -The site can then be built with: - -```bash -jupyter-book start --execute -``` - -This will execute all the notebooks and start a web server to view the rendered -content locally. -View the rendered site by opening the ``localhost:30xy`` in your preferred browser (the exact port number will be printed in your terminal). - -### Adding your own tutorials - -If you have your own tutorial in the form of a Jupyter notebook (a `.ipynb` -file) and you'd like to add it to the repository, follow the steps below. - - -#### Create an issue - -Go to [https://github.com/numpy/numpy-tutorials/issues](https://github.com/numpy/numpy-tutorials/issues) -and create a new issue with your proposal. Give as much detail as you can about -what kind of content you would like to write (tutorial, how-to) and what you -plan to cover. We will try to respond as quickly as possible with comments, if -applicable. - -#### Check out our suggested template - -You can use our [Tutorial Style Guide](content/tutorial-style-guide.md) to make -your content consistent with our existing tutorials. - -#### Upload your content - -
    -
    - - Fork this repository (if you haven't before). - - -
    - -
    - - In your own fork, create a new branch for your content. - - -
    - -
    - - Add your notebook to the content/ directory. - - -
    - -Update the environment.yml file with the dependencies for your -tutorial (only if you add new dependencies). - -
    - - Update this README.md to include your new entry. - - -
    - -Update the attribution section (below) to credit the original tutorial -author, if applicable. - -
    - - Create a pull request. - Make sure the "Allow edits and access to secrets by maintainers" option - is selected so we can properly review your submission. - - -
    - -:tada: Wait for review! -
- -For more information about GitHub and its workflow, you can see -[this document](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests). - - -### Building the Sphinx site locally - -Building the tutorials website, which is published at -https://github.com/numpy/numpy-tutorials, locally isn't necessary before making -a contribution, but may be helpful: - -```bash -conda env create -f environment.yml -conda activate numpy-tutorials -cd site -make html -``` - ## Translations While we don't have the capacity to translate and maintain translated versions