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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -148,7 +148,7 @@ We want your work to be readable by others; therefore, we encourage you to note
148
148
- If you need a third party module that is not in the file __requirements.txt__, please add it to that file as part of your submission.
149
149
150
150
#### Other Requirements for Submissions
151
-
151
+
- If you are submitting code in the `project_euler/` directory, please also read [the dedicated Guideline](https://github.com/TheAlgorithms/Python/blob/master/project_euler/README.md) before contributing to our Project Euler library.
152
152
- The file extension for code files should be `.py`. Jupyter Notebooks should be submitted to [TheAlgorithms/Jupyter](https://github.com/TheAlgorithms/Jupyter).
153
153
- Strictly use snake_case (underscore_separated) in your file_name, as it will be easy to parse in future using scripts.
154
154
- Please avoid creating new directories if at all possible. Try to fit your work into the existing directory structure.
*[Single Bit Manipulation Operations](https://github.com/TheAlgorithms/Python/blob/master/bit_manipulation/single_bit_manipulation_operations.py)
Copy file name to clipboardExpand all lines: project_euler/README.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
1
# Project Euler
2
2
3
-
Problems are taken from https://projecteuler.net/.
3
+
Problems are taken from https://projecteuler.net/, the Project Euler. [Problems are licensed under CC BY-NC-SA 4.0](https://projecteuler.net/copyright).
4
4
5
-
Project Euler is a series of challenging mathematical/computer programming problems that will require more than just mathematical
5
+
Project Euler is a series of challenging mathematical/computer programming problems that require more than just mathematical
6
6
insights to solve. Project Euler is ideal for mathematicians who are learning to code.
7
7
8
-
The solutions will be checked by our [automated testing on Travis CI](https://travis-ci.com/github/TheAlgorithms/Python/pull_requests) with the help of [this script](https://github.com/TheAlgorithms/Python/blob/master/project_euler/validate_solutions.py). The efficiency of your code is also checked. You can view the top 10 slowest solutions on Travis CI logs and open a pull request to improve those solutions.
8
+
The solutions will be checked by our [automated testing on Travis CI](https://travis-ci.com/github/TheAlgorithms/Python/pull_requests) with the help of [this script](https://github.com/TheAlgorithms/Python/blob/master/scripts/validate_solutions.py). The efficiency of your code is also checked. You can view the top 10 slowest solutions on Travis CI logs (under `slowest 10 durations`) and open a pull request to improve those solutions.
9
9
10
10
11
11
## Solution Guidelines
@@ -17,18 +17,18 @@ Welcome to [TheAlgorithms/Python](https://github.com/TheAlgorithms/Python)! Befo
17
17
* Please maintain consistency in project directory and solution file names. Keep the following points in mind:
18
18
* Create a new directory only for the problems which do not exist yet.
19
19
* If you create a new directory, please create an empty `__init__.py` file inside it as well.
20
-
* Please name the project directory as `problem_<problem_number>` where `problem_number` should be filled with 0s so as to occupy 3 digits. Example: `problem_001`, `problem_002`, `problem_067`, `problem_145`, and so on.
20
+
* Please name the project **directory** as `problem_<problem_number>` where `problem_number` should be filled with 0s so as to occupy 3 digits. Example: `problem_001`, `problem_002`, `problem_067`, `problem_145`, and so on.
21
21
22
-
* Please provide a link to the problem and other references, if used, in the module-level docstring.
22
+
* Please provide a link to the problem and other references, if used, in the **module-level docstring**.
23
23
24
24
* All imports should come ***after*** the module-level docstring.
25
25
26
26
* You can have as many helper functions as you want but there should be one main function called `solution` which should satisfy the conditions as stated below:
27
-
* It should contain positional argument(s) whose default value is the question input. Example: Please take a look at [problem 1](https://projecteuler.net/problem=1) where the question is to *Find the sum of all the multiples of 3 or 5 below 1000.* In this case the main solution function will be `solution(limit: int = 1000)`.
27
+
* It should contain positional argument(s) whose default value is the question input. Example: Please take a look at [Problem 1](https://projecteuler.net/problem=1) where the question is to *Find the sum of all the multiples of 3 or 5 below 1000.* In this case the main solution function will be `solution(limit: int = 1000)`.
28
28
* When the `solution` function is called without any arguments like so: `solution()`, it should return the answer to the problem.
29
29
30
30
* Every function, which includes all the helper functions, if any, and the main solution function, should have `doctest` in the function docstring along with a brief statement mentioning what the function is about.
31
-
* There should not be a `doctest` for testing the answer as that is done by our Travis CI build using this [script](https://github.com/TheAlgorithms/Python/blob/master/project_euler/validate_solutions.py). Keeping in mind the above example of [problem 1](https://projecteuler.net/problem=1):
31
+
* There should not be a `doctest` for testing the answer as that is done by our Travis CI build using this [script](https://github.com/TheAlgorithms/Python/blob/master/project_euler/validate_solutions.py). Keeping in mind the above example of [Problem 1](https://projecteuler.net/problem=1):
0 commit comments