diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e4ace75..84d1e24 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,35 +1,46 @@ # What to contribute? -Write any algorithm or data structure in the programming language of your choice, and open a pull request. +Write any algorithm, data structure demo or general application in the programming language of your choice, and open a +pull request. Your request will be assigned to one of the maintainers and reviewed as soon as possible. -# What are the rules? +# Are there any rules? -### 1. -Make sure to add the code to the **appropriate directory**. +### 1. Make sure to put your code in an appropriate directory ``` -+-- problem category (or sub-category) -| +-- programming language -| | +-- your code! +├── problem category (or sub-category) +│ ├── programming language +│ │ └── your code! ``` -If you don't find a proper location for your code, feel free to create it! +If you don't find a proper location, feel free to create it! -### 2. -Make sure to that the code you're adding **is of your own creation.** +### 2. Make sure to that the code you're adding is of your own creation -If you think this goes without saying, then rest assured that this message is not for you; you already abide by this rule. +If you think this goes without saying, then rest assured that this message is not for you; you most likely already abide +by this rule. -[The Hacktoberfest message is strong](https://hacktoberfest.digitalocean.com/details#quality-standards), and we want to be in tune with their values. For that however, -we maintainers have to be strict when dealing with spam, which is plenty, unfortunately. So here's how it goes: +[The Hacktoberfest message is strong](https://hacktoberfest.digitalocean.com/details#quality-standards), and we want to +be in tune with their values. For that however, we maintainers have to be strict when dealing with spam, which is +plenty, unfortunately. So here's how it goes: -- **Spam PRs or PRs containing blatant copies of snippets from the web will be immediately tagged `invalid` and closed.** We use up our free time to read, review -and engage in every pull request made to this repository, and any time we waste with spam is lost by not properly engaging with developers who actually want -to contribute to the event in a constructive manner. +- **Spam PRs or PRs containing blatant copies of snippets from the web will be immediately tagged `invalid` and +closed.** We use up our free time to read, review and engage in every pull request made to this repository, and any time +we waste with spam is lost by not properly engaging with developers who actually want to contribute to the event in a +constructive manner. -- **If you think your PR was wrongfully taken down, post a comment on your PR clarifying the issue, or just send a mail to any of the maintainers (addresses on their respective profiles).** Given the situation described above, it's totally possible that we end up closing your request by mistake, and we apologize -for it. We'll try our best not to though, and if it does happen, be sure that we'll respond to any inquiries as fast as possible. +- **If you think your PR was wrongfully taken down, post a comment on your PR clarifying the issue, or just send a mail +to any of the maintainers (addresses on their respective profiles).** Given the situation described above, it's totally +possible that we end up closing your request by mistake, and we apologize for it. We'll try our best not to though, and +if it does happen, rest assured that we'll respond to any inquiries as fast as possible. Again, We're very sorry if any of this was not for your ears. We hope you understand our need to state all this. If you're reading this, we really do hope you make a contribution here. Happy hacking! :smile: + +# A note on stale requests + +If your pull request has been inactive for too long after a review with requested changes, as in without any follow-ups, +we might end up tagging your request as `stale` and closing it. The conversation will be left open though, and if by +any chance you'd like to follow up on the old PR, just tag any of the maintainers (preferably one of the assignees) +in a comment and we'll re-open and re-review the contribution. diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 0133c7e..91f971e 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -1,3 +1,13 @@ -# Description +### Category -Please include a small description of your algorithm/data structure and add reference to the Hacktoberfest issue (#66) +**EDIT ME** How would you categorize your contribution? (Graph search, greedy algorithm, dynamic programming, machine +learning algorithm, etc... Feel free to classify your code as you see fit.) + +### Description + +**EDIT ME** Please include a small description of your algorithm. Any context you provide will help us review your code +faster and more easily. + +--- + +:beers: Hacktoberfest (#66) diff --git a/README.md b/README.md index 1c56aa3..662d1c1 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,8 @@ As long as it's your own authentic piece of code, it's welcome! :wink: - Want tips on how to write short and sweet commit messages? [Check out this great article](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) -- Make sure to engage the community in a constructive manner! **[Please read our rules and guidelines before contributing]((https://github.com/pirataspinhal/algorithms/issues/126))** +- Make sure to engage the community in a constructive manner! [**Please read our rules and guidelines before contributing**]((https://github.com/pirataspinhal/algorithms/issues/126)) # Credits -Retro computer by Tinashe Mugayi from the Noun Project. +Retro computer by [Tinashe Mugayi](https://thenounproject.com/trellva25/) from the Noun Project. diff --git a/graphs/graph coloring/square_grid_multidim.cpp b/graphs/graph_coloring/square_grid_multidim.cpp similarity index 100% rename from graphs/graph coloring/square_grid_multidim.cpp rename to graphs/graph_coloring/square_grid_multidim.cpp diff --git a/graphs/check bipartite/cpp/CheckBipartite.cpp b/graphs/is_bipartite/cpp/CheckBipartite.cpp similarity index 100% rename from graphs/check bipartite/cpp/CheckBipartite.cpp rename to graphs/is_bipartite/cpp/CheckBipartite.cpp diff --git a/graphs/MBP.py b/graphs/max_bipartite_matching/python/MBP.py similarity index 100% rename from graphs/MBP.py rename to graphs/max_bipartite_matching/python/MBP.py diff --git a/NeuralNetwork/XOR/Network.java b/machine_learning/multilayer_perceptron/XOR/Network.java similarity index 100% rename from NeuralNetwork/XOR/Network.java rename to machine_learning/multilayer_perceptron/XOR/Network.java diff --git a/NeuralNetwork/XOR/XorTest.java b/machine_learning/multilayer_perceptron/XOR/XorTest.java similarity index 100% rename from NeuralNetwork/XOR/XorTest.java rename to machine_learning/multilayer_perceptron/XOR/XorTest.java diff --git a/network/mail_sender.py b/networking/mail_sender.py similarity index 100% rename from network/mail_sender.py rename to networking/mail_sender.py