From ce6c1d9e4576e0f2bd7618f399170661634830fb Mon Sep 17 00:00:00 2001 From: VARUN TOTAKURA Date: Mon, 19 Aug 2024 22:18:10 -0400 Subject: [PATCH 1/7] References issue fixed --- doc/source/contributing/index.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/doc/source/contributing/index.md b/doc/source/contributing/index.md index 4a853266c3..b1b83ec037 100644 --- a/doc/source/contributing/index.md +++ b/doc/source/contributing/index.md @@ -1,7 +1,7 @@ (contributing_guide)= # Contributing to ArviZ ## Welcome -Welcome to the {doc}`ArviZ ` project! +Welcome to the [ArviZ](https://www.arviz.org/en/latest/index.html) project! If you’re reading this guide, that probably means you’d like to get involved and start contributing to the project. ArviZ is a multi-language open-source project that provides tools for exploratory analysis of Bayesian models. @@ -17,7 +17,7 @@ and maximize the probability of such contributions being merged as quickly and a All kinds of contributions to ArviZ, either on its codebase, its documentation, or its community are valuable and we appreciate your help. We constantly encourage non-code contributors to become core contributors -and participate in {ref}`ArviZ governance `. +and participate in [ArviZ governance](https://www.arviz.org/en/latest/governance/index.html#governance). ## Before you begin Before contributing to ArviZ, please make sure to read and observe the [Code of Conduct](https://github.com/arviz-devs/arviz/blob/main/CODE_OF_CONDUCT.md). @@ -33,46 +33,46 @@ but there are many other ways to help the project. Each subsection within this section gives an overview of common contribution types to ArviZ. If you prefer video instead of written form, jump to the next section: -{ref}`contributing_webinar` for a recording of an ArviZ core contributor +[Contributing to ArviZ Webinar](https://python.arviz.org/en/latest/contributing/index.html#contributing-webinar) for a recording of an ArviZ core contributor on both technical and social aspects of contributing to the library. You can contribute to ArviZ in the following ways: ### Create an issue -[Submit issues](https://github.com/arviz-devs/arviz/issues/new/choose) for existing bugs or desired enhancements. Check {ref}`issue_reports` for details on how to write an issue. +[Submit issues](https://github.com/arviz-devs/arviz/issues/new/choose) for existing bugs or desired enhancements. Check [Issue reports](https://python.arviz.org/en/latest/contributing/issue_reports.html#issue-reports) for details on how to write an issue. ### Translate ArviZ website -You can {ref}`translate ` our website to languages other than English. +You can [translate](https://python.arviz.org/en/latest/contributing/translate.html#translate) our website to languages other than English. ### Review PRs -{ref}`Review pull requests ` to ensure that the contributions are well tested and documented. +[Review pull requests](https://python.arviz.org/en/latest/contributing/review_prs.html#review-prs) to ensure that the contributions are well tested and documented. For example, you can check if the documentation renders correctly and has no typos or mistakes. ### Manage issues Helping to manage or triage the open issues can be a great contribution and a great opportunity to learn about the various areas of the project. -You can {ref}`triage existing issues ` to make them clear and/or provide temporary workarounds for them. +You can [triage existing issues](https://python.arviz.org/en/latest/contributing/issue_triaging.html#issue-triaging) to make them clear and/or provide temporary workarounds for them. ### Write documentation You can contribute to ArviZ’s documentation by either creating new content or editing existing content. For instance, you can add new ArviZ examples. To get involved with the documentation: -1. Familiarize yourself with the {ref}`documentation content structure ` and the {ref}`tool chain ` involved in creating the website. -2. Understand the basic workflow for opening a {ref}`pull request ` and {ref}`reviewing changes `. +1. Familiarize yourself with the [documentation content structure](https://python.arviz.org/en/latest/contributing/content_structure.html#content-structure) and the [tool chain](https://python.arviz.org/en/latest/contributing/doc_toolchain.html#doc-toolchain) involved in creating the website. +2. Understand the basic workflow for opening a [pull request](https://python.arviz.org/en/latest/contributing/pr_tutorial.html#pr-tutorial) and [reviewing changes](https://python.arviz.org/en/latest/contributing/review_prs.html#review-prs). 3. Work on your content. -4. {ref}`Build ` your documentation and preview the doc changes. +4. [Build](https://python.arviz.org/en/latest/contributing/sphinx_doc_build.html#sphinx-doc-build) your documentation and preview the doc changes. ### Support outreach initiatives -Support ArviZ {ref}`outreach initiatives ` such as writing blog posts, case studies, getting people to use ArviZ at your company or university, etc. +Support ArviZ [outreach initiatives](https://python.arviz.org/en/latest/contributing/outreach.html#oureach-contrib) such as writing blog posts, case studies, getting people to use ArviZ at your company or university, etc. ### Make changes in the code Fix outstanding issues (bugs) in the existing codebase. The issue can range from low-level software bugs to high-level design problems. You can also add new features to the codebase or improve the existing functionality. To fix bugs or add new features, do the following: -1. Familiarize yourself with the {ref}`guidelines ` before starting your work. -2. Understand the {ref}`development process ` and code conventions. -3. Understand the basic workflow for opening a {ref}`pull request ` and {ref}`reviewing ` changes. +1. Familiarize yourself with the [guidelines](https://python.arviz.org/en/latest/contributing/contributing_prs.html#steps-before-working) before starting your work. +2. Understand the [development process](https://python.arviz.org/en/latest/contributing/contributing_prs.html#dev-summary) and code conventions. +3. Understand the basic workflow for opening a [pull request](https://python.arviz.org/en/latest/contributing/pr_tutorial.html#pr-tutorial) and [reviewing](https://python.arviz.org/en/latest/contributing/review_prs.html#review-prs) changes. 4. Review and test your code. (contributing_webinar)= From ce7f57376cdfdcf1fcc9296df32ada465fafb338 Mon Sep 17 00:00:00 2001 From: VARUN TOTAKURA Date: Mon, 19 Aug 2024 22:52:29 -0400 Subject: [PATCH 2/7] Changelog Created --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8ecd1fecce..1e9cfbdaa5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ ### Deprecation ### Documentation +- Fixed the issue in the [Contribution References Documentation](https://python.arviz.org/en/latest/contributing/index.html) ([2369](https://github.com/arviz-devs/arviz/issues/2369)) ## v0.19.0 (2024 Jul 19) From aad274f556da590ab8ff49c0bccbb1b1fe203f9b Mon Sep 17 00:00:00 2001 From: VARUN TOTAKURA Date: Thu, 22 Aug 2024 12:43:43 -0400 Subject: [PATCH 3/7] Link issue fix #2369 --- doc/source/contributing/index.md | 28 +++++++++++++------------- doc/source/contributing/pr_tutorial.md | 1 + 2 files changed, 15 insertions(+), 14 deletions(-) diff --git a/doc/source/contributing/index.md b/doc/source/contributing/index.md index b1b83ec037..4a853266c3 100644 --- a/doc/source/contributing/index.md +++ b/doc/source/contributing/index.md @@ -1,7 +1,7 @@ (contributing_guide)= # Contributing to ArviZ ## Welcome -Welcome to the [ArviZ](https://www.arviz.org/en/latest/index.html) project! +Welcome to the {doc}`ArviZ ` project! If you’re reading this guide, that probably means you’d like to get involved and start contributing to the project. ArviZ is a multi-language open-source project that provides tools for exploratory analysis of Bayesian models. @@ -17,7 +17,7 @@ and maximize the probability of such contributions being merged as quickly and a All kinds of contributions to ArviZ, either on its codebase, its documentation, or its community are valuable and we appreciate your help. We constantly encourage non-code contributors to become core contributors -and participate in [ArviZ governance](https://www.arviz.org/en/latest/governance/index.html#governance). +and participate in {ref}`ArviZ governance `. ## Before you begin Before contributing to ArviZ, please make sure to read and observe the [Code of Conduct](https://github.com/arviz-devs/arviz/blob/main/CODE_OF_CONDUCT.md). @@ -33,46 +33,46 @@ but there are many other ways to help the project. Each subsection within this section gives an overview of common contribution types to ArviZ. If you prefer video instead of written form, jump to the next section: -[Contributing to ArviZ Webinar](https://python.arviz.org/en/latest/contributing/index.html#contributing-webinar) for a recording of an ArviZ core contributor +{ref}`contributing_webinar` for a recording of an ArviZ core contributor on both technical and social aspects of contributing to the library. You can contribute to ArviZ in the following ways: ### Create an issue -[Submit issues](https://github.com/arviz-devs/arviz/issues/new/choose) for existing bugs or desired enhancements. Check [Issue reports](https://python.arviz.org/en/latest/contributing/issue_reports.html#issue-reports) for details on how to write an issue. +[Submit issues](https://github.com/arviz-devs/arviz/issues/new/choose) for existing bugs or desired enhancements. Check {ref}`issue_reports` for details on how to write an issue. ### Translate ArviZ website -You can [translate](https://python.arviz.org/en/latest/contributing/translate.html#translate) our website to languages other than English. +You can {ref}`translate ` our website to languages other than English. ### Review PRs -[Review pull requests](https://python.arviz.org/en/latest/contributing/review_prs.html#review-prs) to ensure that the contributions are well tested and documented. +{ref}`Review pull requests ` to ensure that the contributions are well tested and documented. For example, you can check if the documentation renders correctly and has no typos or mistakes. ### Manage issues Helping to manage or triage the open issues can be a great contribution and a great opportunity to learn about the various areas of the project. -You can [triage existing issues](https://python.arviz.org/en/latest/contributing/issue_triaging.html#issue-triaging) to make them clear and/or provide temporary workarounds for them. +You can {ref}`triage existing issues ` to make them clear and/or provide temporary workarounds for them. ### Write documentation You can contribute to ArviZ’s documentation by either creating new content or editing existing content. For instance, you can add new ArviZ examples. To get involved with the documentation: -1. Familiarize yourself with the [documentation content structure](https://python.arviz.org/en/latest/contributing/content_structure.html#content-structure) and the [tool chain](https://python.arviz.org/en/latest/contributing/doc_toolchain.html#doc-toolchain) involved in creating the website. -2. Understand the basic workflow for opening a [pull request](https://python.arviz.org/en/latest/contributing/pr_tutorial.html#pr-tutorial) and [reviewing changes](https://python.arviz.org/en/latest/contributing/review_prs.html#review-prs). +1. Familiarize yourself with the {ref}`documentation content structure ` and the {ref}`tool chain ` involved in creating the website. +2. Understand the basic workflow for opening a {ref}`pull request ` and {ref}`reviewing changes `. 3. Work on your content. -4. [Build](https://python.arviz.org/en/latest/contributing/sphinx_doc_build.html#sphinx-doc-build) your documentation and preview the doc changes. +4. {ref}`Build ` your documentation and preview the doc changes. ### Support outreach initiatives -Support ArviZ [outreach initiatives](https://python.arviz.org/en/latest/contributing/outreach.html#oureach-contrib) such as writing blog posts, case studies, getting people to use ArviZ at your company or university, etc. +Support ArviZ {ref}`outreach initiatives ` such as writing blog posts, case studies, getting people to use ArviZ at your company or university, etc. ### Make changes in the code Fix outstanding issues (bugs) in the existing codebase. The issue can range from low-level software bugs to high-level design problems. You can also add new features to the codebase or improve the existing functionality. To fix bugs or add new features, do the following: -1. Familiarize yourself with the [guidelines](https://python.arviz.org/en/latest/contributing/contributing_prs.html#steps-before-working) before starting your work. -2. Understand the [development process](https://python.arviz.org/en/latest/contributing/contributing_prs.html#dev-summary) and code conventions. -3. Understand the basic workflow for opening a [pull request](https://python.arviz.org/en/latest/contributing/pr_tutorial.html#pr-tutorial) and [reviewing](https://python.arviz.org/en/latest/contributing/review_prs.html#review-prs) changes. +1. Familiarize yourself with the {ref}`guidelines ` before starting your work. +2. Understand the {ref}`development process ` and code conventions. +3. Understand the basic workflow for opening a {ref}`pull request ` and {ref}`reviewing ` changes. 4. Review and test your code. (contributing_webinar)= diff --git a/doc/source/contributing/pr_tutorial.md b/doc/source/contributing/pr_tutorial.md index 0775828a9a..6c52bbfb56 100644 --- a/doc/source/contributing/pr_tutorial.md +++ b/doc/source/contributing/pr_tutorial.md @@ -1,3 +1,4 @@ +(pr_tutorial)= # Pull request step-by-step The preferred workflow for contributing to ArviZ is to fork From eb818c1f8547b4859d9cc19c8d7b63da773f6801 Mon Sep 17 00:00:00 2001 From: VARUN TOTAKURA Date: Sat, 24 Aug 2024 17:29:03 -0400 Subject: [PATCH 4/7] ignore virtual envs (2371) --- .gitignore | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/.gitignore b/.gitignore index 3a70d32d1a..1b557620a0 100644 --- a/.gitignore +++ b/.gitignore @@ -28,6 +28,13 @@ var/ .ipynb_checkpoints .virtual_documents +# Environments +.env +.venv +env/ +venv/ +ENV/ + # PyInstaller # Usually these files are written by a python script from a template # before PyInstaller builds the exe, so as to inject date/other infos into it. From 90e649f130c46375b96d3312228798fdd1f979c5 Mon Sep 17 00:00:00 2001 From: VARUN TOTAKURA Date: Sat, 24 Aug 2024 17:38:22 -0400 Subject: [PATCH 5/7] Add changelog for #2371 --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1e9cfbdaa5..221be8d8f1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,7 +9,7 @@ ### Deprecation ### Documentation -- Fixed the issue in the [Contribution References Documentation](https://python.arviz.org/en/latest/contributing/index.html) ([2369](https://github.com/arviz-devs/arviz/issues/2369)) +- Added extensions of virtual environments in [.gitignore](https://github.com/arviz-devs/arviz/blob/main/.gitignore) ([2371](https://github.com/arviz-devs/arviz/issues/2371)) ## v0.19.0 (2024 Jul 19) From 4cb9ad6b08461b7b759f76d71585c87e2b5f968b Mon Sep 17 00:00:00 2001 From: VARUN TOTAKURA Date: Sat, 24 Aug 2024 17:42:19 -0400 Subject: [PATCH 6/7] Revert "Add changelog for #2371" This reverts commit 90e649f130c46375b96d3312228798fdd1f979c5. --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 221be8d8f1..1e9cfbdaa5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,7 +9,7 @@ ### Deprecation ### Documentation -- Added extensions of virtual environments in [.gitignore](https://github.com/arviz-devs/arviz/blob/main/.gitignore) ([2371](https://github.com/arviz-devs/arviz/issues/2371)) +- Fixed the issue in the [Contribution References Documentation](https://python.arviz.org/en/latest/contributing/index.html) ([2369](https://github.com/arviz-devs/arviz/issues/2369)) ## v0.19.0 (2024 Jul 19) From 5cbe0e88f8d380c351c8e6a8599b1e771fbc3f87 Mon Sep 17 00:00:00 2001 From: VARUN TOTAKURA Date: Sat, 24 Aug 2024 17:44:18 -0400 Subject: [PATCH 7/7] Add changelog for #2371 --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1e9cfbdaa5..942461eb91 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ ### Deprecation ### Documentation +- Added extensions of virtual environments in [.gitignore](https://github.com/arviz-devs/arviz/blob/main/.gitignore) ([2371](https://github.com/arviz-devs/arviz/issues/2371)) - Fixed the issue in the [Contribution References Documentation](https://python.arviz.org/en/latest/contributing/index.html) ([2369](https://github.com/arviz-devs/arviz/issues/2369)) ## v0.19.0 (2024 Jul 19)