Skip to content

Updated data-structures-and-algorithms/python/README #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Updated data-structures-and-algorithms/python/README #102

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
59dc63b
Update README.md
cacosta12345 Mar 27, 2024
44d37a5
Merge pull request #1 from cacosta12345/cacosta12345-patch-1
cacosta12345 Mar 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions python/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ Each type of code challenge has slightly different instructions. Please refer to

### Data Structure: New Implementation

- Create a new folder under the `python` level, with the name of the data structure and complete your implementation there
- Find the data-structure file under the `python/data_structures` level with the name of the data structure and complete your implementation there
- If there is not a file there already for the specified data-structure, then create a new file under the `python/data_structures` level, with the name of the data structure and complete your implementation there
- i.e. `linked_list`
- Implementation (the data structure "class")
- The implementation of the data structure should match package name
Expand All @@ -25,8 +26,8 @@ Each type of code challenge has slightly different instructions. Please refer to
```

- Tests
- Within folder `tests` create a test file called `test_[data_structure].py`
- i.e. `tests/test_linked_list.py`
- Within folder `tests/code_challenges` or `tests/data_structures` find a test file called `test_[data_structure].py`
- i.e. `tests/data_structures/test_linked_list.py`
- Your tests will then need to require the data structure you're testing
- i.e. `from linked_list.linked_list import LinkedList`

Expand All @@ -45,7 +46,8 @@ Each type of code challenge has slightly different instructions. Please refer to
Code challenges should be completed within a folder named `code_challenges` under the `python` level

- Daily Setup:
- Create a new folder under the `python` level, with the name of the code challenge
- Find the file under the `python/code_challenges` level, with the name of the code challenge
- If the file does not exist, create a new file under the `python/code_challenges` level, with the name of the code challenge
- Each code challenge assignment identifies the branch name to use, for example 'find-maximum-value'
- For clarity, create your folder with the same name, ensuring that it's `snake_cased`
- i.e. For a challenge named 'find_maximum_value', create the folder:`code_challenges/find_maximum_value`
Expand Down