You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
> This repo is currently still under development. Currently there is a beta version that have the basic simulation feature finished. If you encountered any issue, please open up an issue and let me know! I will try to fix them as soon as possible.
-[Code of Conduct](https://github.com/FlysonBot/Mastermind/blob/main/.github/CODE_OF_CONDUCT.md)
23
+
-[Play Online on Google Colab](https://colab.research.google.com/github/FlysonBot/Mastermind/blob/main/examples/mastermind_in_colab.ipynb)
23
24
24
25
# Mastermind
25
26
@@ -29,6 +30,12 @@
29
30
30
31
Mastermind is a code-breaking game for two players. The first player (the code-setter) creates a secret code, which the second player (the code-cracker) tries to guess. The code-cracker has a limited number of attempts to guess the code correctly. After each guess, the code-setter provides feedback to the code-cracker, indicating how many dots have the right color and are in the right place, and how many are the right color but in the wrong place. The code-cracker uses this feedback to refine their guesses until they correctly guess the code or run out of attempts.
31
32
33
+
## Contribution Wanted!!!
34
+
35
+
Currently the project only has 1 contributor, me, and I'm getting busy on schoolwork. Please come and contribtue! You don't need to know how to code to contribute. Simple open up [issues](https://github.com/FlysonBot/Mastermind/issues) or [discussion](https://github.com/FlysonBot/Mastermind/discussions) when you found bugs or have some suggestion to the project.
36
+
37
+
If you want to contribute to the code, feel free to fork and submit pull request! Try to follow the [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) style when writing commit message. Any help is appreciated! To get started, you can take a look at the issues labeled as [good first issue](https://github.com/FlysonBot/Mastermind/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) which contain a list of tasks that are easy to do that can help you get started with contributing to the project!
38
+
32
39
## Getting Started
33
40
34
41
### Prerequisites
@@ -38,7 +45,7 @@ To run this project, you must have the following installed (installation guide b
38
45
- Python 3.10 (or higher)
39
46
- pip (comes with Python, needed to install the project as a library)
40
47
41
-
Or alternatively you can run this program in your browser with [Google Colab](https://colab.research.google.com/github/FlysonBot/Mastermind/blob/main/mastermind_in_colab.ipynb)
48
+
Or alternatively you can run this program in your browser with [Google Colab](https://colab.research.google.com/github/FlysonBot/Mastermind/blob/main/examples/mastermind_in_colab.ipynb)
42
49
43
50
### Installation Guide
44
51
@@ -104,7 +111,7 @@ Contributions are welcome! Please open an issue or submit a pull request.
104
111
105
112
All contributors must adhere to the [Contributor Covenant Code of Conduct](https://github.com/FlysonBot/Mastermind/blob/main/.github/CODE_OF_CONDUCT.md) to ensure a welcoming and inclusive environment for all contributors.
106
113
107
-
To contribute to the code directly, you must also follow the [Contributing Guidelines](https://github.com/FlysonBot/Mastermind/blob/main/CONTRIBUTING.md) to ensure a smooth and efficient collaboration process.
114
+
To contribute to the code directly, you must also follow the [Contributing Guidelines](https://github.com/FlysonBot/Mastermind/blob/main/.github/CONTRIBUTING.md) to ensure a smooth and efficient collaboration process.
0 commit comments