diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..a1d15af --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,6 @@ +blank_issues_enabled: false + +contact_links: + - name: "\U00002753Questions" + url: "https://github.com/ansegura7/Algorithms/discussions" + about: "Use the GitHub Discussions to ask support questions." diff --git a/README.md b/README.md index 080234b..c18bec5 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ![version](https://img.shields.io/badge/version-Pro-blue) ![release](https://img.shields.io/badge/release-1.2.3-blue) ![language](https://img.shields.io/badge/language-Python_3.7%7C3.8-brightgreen) -![last-update](https://img.shields.io/badge/last_update-08/11/2021-orange) +![last-update](https://img.shields.io/badge/last_update-10/18/2023-orange) ![last-update](https://img.shields.io/badge/license-MIT-orange) Free hands-on course with the implementation (in Python) and description of several computational, mathematical and statistical algorithms. @@ -13,7 +13,7 @@ Although it is not intended to have the formal rigor of a book, we tried to be a The best way to get the most out of this course is to carefully read each selected problem, try to think of a possible solution (language independent) and then look at the proposed Python code and try to reproduce it in your favorite IDE. If you already have knowledge of the Python language, then you can go directly to programming your solution and then compare it with the one proposed in the course. If you want to play with these notebooks online without having to install any library or configure hardware, you can use the following service: -- Open In Colab +- Open In Colab ## What is an algorithm? In mathematics and computer science, an algorithm is a finite sequence of well-defined, computer-implementable instructions, typically to solve a class of problems or to perform a computation. @@ -112,9 +112,12 @@ In mathematics and computer science, an algorithm is a finite sequence of well-d ## Contributing and Feedback Any kind of feedback/suggestions would be greatly appreciated (algorithm design, documentation, improvement ideas, spelling mistakes, etc...). If you want to make a contribution to the course you can do it through a PR. +## Documentation +Please read the [contributing](https://github.com/ansegura7/Algorithms/blob/main/docs/CONTRIBUTING.md) and [code of conduct](https://github.com/ansegura7/Algorithms/blob/main/docs/CODE_OF_CONDUCT.md) documentation. + ## Author - Created by Andrés Segura-Tinoco - Created on May 17, 2019 ## License -This project is licensed under the terms of the MIT license. +This project is licensed under the terms of the MIT license. diff --git a/basics/AlgorithmsBasics.html b/basics/AlgorithmsBasics.html index f4bfe24..dc48246 100644 --- a/basics/AlgorithmsBasics.html +++ b/basics/AlgorithmsBasics.html @@ -11331,11 +11331,11 @@ /** * " * Using Zenburn color palette from the Emacs Zenburn Theme - * https://github.com/bbatsov/zenburn-emacs/blob/master/zenburn-theme.el + * https://github.com/bbatsov/zenburn-emacs/blob/main/zenburn-theme.el * * Also using parts of https://github.com/xavi/coderay-lighttable-theme * " - * From: https://github.com/wisenomad/zenburn-lighttable-theme/blob/master/zenburn.css + * From: https://github.com/wisenomad/zenburn-lighttable-theme/blob/main/zenburn.css */ .cm-s-zenburn .CodeMirror-gutters { background: #3f3f3f !important; } @@ -11555,7 +11555,7 @@ /****************************************************************/ /* Based on mbonaci's Brackets mbo theme */ -/* https://github.com/mbonaci/global/blob/master/Mbo.tmTheme */ +/* https://github.com/mbonaci/global/blob/main/Mbo.tmTheme */ /* Create your own: http://tmtheme-editor.herokuapp.com */ /****************************************************************/ diff --git a/cellular-automata/CellularAutomata.html b/cellular-automata/CellularAutomata.html index f5d820a..5816246 100644 --- a/cellular-automata/CellularAutomata.html +++ b/cellular-automata/CellularAutomata.html @@ -11331,11 +11331,11 @@ /** * " * Using Zenburn color palette from the Emacs Zenburn Theme - * https://github.com/bbatsov/zenburn-emacs/blob/master/zenburn-theme.el + * https://github.com/bbatsov/zenburn-emacs/blob/main/zenburn-theme.el * * Also using parts of https://github.com/xavi/coderay-lighttable-theme * " - * From: https://github.com/wisenomad/zenburn-lighttable-theme/blob/master/zenburn.css + * From: https://github.com/wisenomad/zenburn-lighttable-theme/blob/main/zenburn.css */ .cm-s-zenburn .CodeMirror-gutters { background: #3f3f3f !important; } @@ -11555,7 +11555,7 @@ /****************************************************************/ /* Based on mbonaci's Brackets mbo theme */ -/* https://github.com/mbonaci/global/blob/master/Mbo.tmTheme */ +/* https://github.com/mbonaci/global/blob/main/Mbo.tmTheme */ /* Create your own: http://tmtheme-editor.herokuapp.com */ /****************************************************************/ diff --git a/chaotic-systems/ChaoticSystems.html b/chaotic-systems/ChaoticSystems.html index c5068a7..00af1f1 100644 --- a/chaotic-systems/ChaoticSystems.html +++ b/chaotic-systems/ChaoticSystems.html @@ -11331,11 +11331,11 @@ /** * " * Using Zenburn color palette from the Emacs Zenburn Theme - * https://github.com/bbatsov/zenburn-emacs/blob/master/zenburn-theme.el + * https://github.com/bbatsov/zenburn-emacs/blob/main/zenburn-theme.el * * Also using parts of https://github.com/xavi/coderay-lighttable-theme * " - * From: https://github.com/wisenomad/zenburn-lighttable-theme/blob/master/zenburn.css + * From: https://github.com/wisenomad/zenburn-lighttable-theme/blob/main/zenburn.css */ .cm-s-zenburn .CodeMirror-gutters { background: #3f3f3f !important; } @@ -11555,7 +11555,7 @@ /****************************************************************/ /* Based on mbonaci's Brackets mbo theme */ -/* https://github.com/mbonaci/global/blob/master/Mbo.tmTheme */ +/* https://github.com/mbonaci/global/blob/main/Mbo.tmTheme */ /* Create your own: http://tmtheme-editor.herokuapp.com */ /****************************************************************/ diff --git a/divide-and-conquer/DivideAndConquer.html b/divide-and-conquer/DivideAndConquer.html index 9707068..090344b 100644 --- a/divide-and-conquer/DivideAndConquer.html +++ b/divide-and-conquer/DivideAndConquer.html @@ -11331,11 +11331,11 @@ /** * " * Using Zenburn color palette from the Emacs Zenburn Theme - * https://github.com/bbatsov/zenburn-emacs/blob/master/zenburn-theme.el + * https://github.com/bbatsov/zenburn-emacs/blob/main/zenburn-theme.el * * Also using parts of https://github.com/xavi/coderay-lighttable-theme * " - * From: https://github.com/wisenomad/zenburn-lighttable-theme/blob/master/zenburn.css + * From: https://github.com/wisenomad/zenburn-lighttable-theme/blob/main/zenburn.css */ .cm-s-zenburn .CodeMirror-gutters { background: #3f3f3f !important; } @@ -11555,7 +11555,7 @@ /****************************************************************/ /* Based on mbonaci's Brackets mbo theme */ -/* https://github.com/mbonaci/global/blob/master/Mbo.tmTheme */ +/* https://github.com/mbonaci/global/blob/main/Mbo.tmTheme */ /* Create your own: http://tmtheme-editor.herokuapp.com */ /****************************************************************/ diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..9111524 --- /dev/null +++ b/docs/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement. + +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000..3de3286 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,35 @@ +# Contributing +Welcome, and thank you for your interest in helping to improve and accelerate/ease the adoption of the Python Algorithms Course. + +There are many ways in which you can contribute, beyond writing code. The goal of this document is to provide a high-level overview of how you can get involved, and hopefully not feel intimidated. + +## Asking Questions and Providing Feedback +Have a question? Rather than emailing the author, open an issue. + +The community will be eager to assist you. Your well-worded question will serve as a resource to others searching for help. + +## Reporting Issues and Ideas +Have you identified an oversight or problem? Have a feature request? We want to hear about it! Here's how you can make reporting your issue as effective as possible. + +> **Note:** If you already know what you want to change, feel free to just fork/clone the repo, change it, and submit a pull request. No need to add overhead by creating an issue! + +### Look For an Existing Issue +Before you create a new issue, please do a search in [open issues](https://github.com/ansegura7/Algorithms/issues) to see if the issue or feature request has already been filed. + +If you cannot find an existing issue that describes your bug or feature, create a new issue using the guidelines below. + +### Writing Good Bug Reports and Feature Requests +File a single issue per problem and feature request. Do not enumerate multiple bugs or feature requests in the same issue. + +Below is some information you can provide. The more you can provide, the more likely someone will be successful at understanding and incorporating it. However be mindful of the cost/benefit for documenting vs simply implementing the change. + +Please include the following with each issue: +- **Title** - Concise and clear to quickly identify the topic. +- **Problem** - Summary of the issue/idea/feature. +- **Possible Solution** - If a solution seems clear, share it as an option. +- **Examples** - "What was expected" vs "What actually ocurred". +- **Context** - External factors that restrict possible solutions. (stuff that can't be changed) + > Example: Please upgrade the vehicle from 30mph to 60mph. Context: budget is $5000. + +# Thank You! +Your contributions to the Python Algorithms Course, large or small, make great projects like this possible. Thank you for taking the time to contribute! diff --git a/dynamic-programming/DynamicProgramming.html b/dynamic-programming/DynamicProgramming.html index 43f597e..243ee52 100644 --- a/dynamic-programming/DynamicProgramming.html +++ b/dynamic-programming/DynamicProgramming.html @@ -11331,11 +11331,11 @@ /** * " * Using Zenburn color palette from the Emacs Zenburn Theme - * https://github.com/bbatsov/zenburn-emacs/blob/master/zenburn-theme.el + * https://github.com/bbatsov/zenburn-emacs/blob/main/zenburn-theme.el * * Also using parts of https://github.com/xavi/coderay-lighttable-theme * " - * From: https://github.com/wisenomad/zenburn-lighttable-theme/blob/master/zenburn.css + * From: https://github.com/wisenomad/zenburn-lighttable-theme/blob/main/zenburn.css */ .cm-s-zenburn .CodeMirror-gutters { background: #3f3f3f !important; } @@ -11555,7 +11555,7 @@ /****************************************************************/ /* Based on mbonaci's Brackets mbo theme */ -/* https://github.com/mbonaci/global/blob/master/Mbo.tmTheme */ +/* https://github.com/mbonaci/global/blob/main/Mbo.tmTheme */ /* Create your own: http://tmtheme-editor.herokuapp.com */ /****************************************************************/ diff --git a/graphs/Graphs.html b/graphs/Graphs.html index f378190..6883429 100644 --- a/graphs/Graphs.html +++ b/graphs/Graphs.html @@ -11331,11 +11331,11 @@ /** * " * Using Zenburn color palette from the Emacs Zenburn Theme - * https://github.com/bbatsov/zenburn-emacs/blob/master/zenburn-theme.el + * https://github.com/bbatsov/zenburn-emacs/blob/main/zenburn-theme.el * * Also using parts of https://github.com/xavi/coderay-lighttable-theme * " - * From: https://github.com/wisenomad/zenburn-lighttable-theme/blob/master/zenburn.css + * From: https://github.com/wisenomad/zenburn-lighttable-theme/blob/main/zenburn.css */ .cm-s-zenburn .CodeMirror-gutters { background: #3f3f3f !important; } @@ -11555,7 +11555,7 @@ /****************************************************************/ /* Based on mbonaci's Brackets mbo theme */ -/* https://github.com/mbonaci/global/blob/master/Mbo.tmTheme */ +/* https://github.com/mbonaci/global/blob/main/Mbo.tmTheme */ /* Create your own: http://tmtheme-editor.herokuapp.com */ /****************************************************************/ diff --git a/probabilistic-algorithms/ProbabilisticAlgorithms.html b/probabilistic-algorithms/ProbabilisticAlgorithms.html index 5b71f40..cbbfdcf 100644 --- a/probabilistic-algorithms/ProbabilisticAlgorithms.html +++ b/probabilistic-algorithms/ProbabilisticAlgorithms.html @@ -11331,11 +11331,11 @@ /** * " * Using Zenburn color palette from the Emacs Zenburn Theme - * https://github.com/bbatsov/zenburn-emacs/blob/master/zenburn-theme.el + * https://github.com/bbatsov/zenburn-emacs/blob/main/zenburn-theme.el * * Also using parts of https://github.com/xavi/coderay-lighttable-theme * " - * From: https://github.com/wisenomad/zenburn-lighttable-theme/blob/master/zenburn.css + * From: https://github.com/wisenomad/zenburn-lighttable-theme/blob/main/zenburn.css */ .cm-s-zenburn .CodeMirror-gutters { background: #3f3f3f !important; } @@ -11555,7 +11555,7 @@ /****************************************************************/ /* Based on mbonaci's Brackets mbo theme */ -/* https://github.com/mbonaci/global/blob/master/Mbo.tmTheme */ +/* https://github.com/mbonaci/global/blob/main/Mbo.tmTheme */ /* Create your own: http://tmtheme-editor.herokuapp.com */ /****************************************************************/ diff --git a/similarity-functions/SimilarityFunctions.html b/similarity-functions/SimilarityFunctions.html index 710d4f8..9d997e4 100644 --- a/similarity-functions/SimilarityFunctions.html +++ b/similarity-functions/SimilarityFunctions.html @@ -11331,11 +11331,11 @@ /** * " * Using Zenburn color palette from the Emacs Zenburn Theme - * https://github.com/bbatsov/zenburn-emacs/blob/master/zenburn-theme.el + * https://github.com/bbatsov/zenburn-emacs/blob/main/zenburn-theme.el * * Also using parts of https://github.com/xavi/coderay-lighttable-theme * " - * From: https://github.com/wisenomad/zenburn-lighttable-theme/blob/master/zenburn.css + * From: https://github.com/wisenomad/zenburn-lighttable-theme/blob/main/zenburn.css */ .cm-s-zenburn .CodeMirror-gutters { background: #3f3f3f !important; } @@ -11555,7 +11555,7 @@ /****************************************************************/ /* Based on mbonaci's Brackets mbo theme */ -/* https://github.com/mbonaci/global/blob/master/Mbo.tmTheme */ +/* https://github.com/mbonaci/global/blob/main/Mbo.tmTheme */ /* Create your own: http://tmtheme-editor.herokuapp.com */ /****************************************************************/