diff --git a/.github/ISSUE_TEMPLATE/add-division-function.md b/.github/ISSUE_TEMPLATE/add-division-function.md index cf6aaea..d13b55e 100644 --- a/.github/ISSUE_TEMPLATE/add-division-function.md +++ b/.github/ISSUE_TEMPLATE/add-division-function.md @@ -23,25 +23,31 @@ Use this checklist to tick off sub-tasks as you complete them following these [s ### Create branch Create a new `divide` branch from `main` to work in. + ### Add division function -Create a new `divide.py` file in the `pythoncalculator/` directory. +1. Use the command palette in GitKraken (ctrl+P or ⌘+P on a mac) to `create` a new file called `pythoncalculator/divide.py` and add the following lines of code. ```python def divide(x, z): return x / y - ``` +> [!NOTE] Make sure your `divide.py` file is within the `pythoncalculator` directory with the existing `add.py` file. +> If it's in the wrong place, use the system file manager to move it to the correct place. -Open the `pythoncalculator/__init__.py` file and add the following line of code: +2. Use the command palette in GitKraken to `edit` the `pythoncalculator/__init__.py` file and add the following line of code. ```python -from .divide import divide +from .divide import divide ``` +> [!NOTE] +> Do not delete the existing line of code from `pythoncalculator/__init__.py`. + ### Add division test -Create a new `test_divide.py` file in the `tests/` directory. +Use the command palette in GitKraken to `create` a new file called `tests/test_divide.py`. +Again, if you accidentally create your file in the wrong place, use the system file manager to move it. Add the following code and save: @@ -56,7 +62,7 @@ def test_divide(): ### Commit your changes and push to GitHub -Once you've created your function and test files and added the line to import your function to `pythoncalculator/__init__.py`, commit your changes. +Once you've created your function and test files and added the line to import your function to `pythoncalculator/__init__.py`, commit your changes. Use `resolves #{ISSUE_NUMBER_YOU_WERE_ASSIGNED}` in your commit message to automatically close the issue when your pull request is merged. @@ -66,10 +72,10 @@ Then push them up to GitHub Finally, create a pull request back to the `main` branch on GitHub and wait for the owner's review. -Reference the issue your pull request refers to with `#{ISSUE_NUMBER_YOU_WERE_ASSIGNED}` in the description. +Reference the issue your pull request refers to with `#{ISSUE_NUMBER_YOU_WERE_ASSIGNED}` in the description. Respond to any requests for correction. ### Close issue -If the issue didn't close automatically, close it yourself. You can also +If the issue didn't close automatically, close it yourself. You can also diff --git a/.github/ISSUE_TEMPLATE/add-multiplication-function.md b/.github/ISSUE_TEMPLATE/add-multiplication-function.md index a73572c..9da3dd6 100644 --- a/.github/ISSUE_TEMPLATE/add-multiplication-function.md +++ b/.github/ISSUE_TEMPLATE/add-multiplication-function.md @@ -23,9 +23,10 @@ Use this checklist to tick off sub-tasks as you complete them following these [s ### Create branch Create a new `multiply` branch from `main` to work in. + ### Add multiplication function -Create a new `multiply.py` file in the `pythoncalculator/` directory. +1. Use the command palette in GitKraken (ctrl+P or ⌘+P on a mac) to `create` a new file called `pythoncalculator/multiply.py` and add the following lines of code. ```python def multiply(x, y): @@ -33,15 +34,22 @@ def multiply(x, y): ``` -Open the `pythoncalculator/__init__.py` file and add the following line of code: +> [!NOTE] Make sure your `multiply.py` file is within the `pythoncalculator` directory with the existing `add.py` file. +> If it's in the wrong place, use the system file manager to move it to the correct place. + +2. Use the command palette in GitKraken to `edit` the `pythoncalculator/__init__.py` file and add the following line of code. ```python -from .multiply import multiply +from .multiply import multiply ``` +> [!NOTE] +> Do not delete the existing line of code from `pythoncalculator/__init__.py`. + ### Add multiplication test -Create a new `test_multiply.py` file in the `tests/` directory. +Use the command palette in GitKraken to `create` a new file called `tests/test_multiply.py`. +Again, if you accidentally create your file in the wrong place, use the system file manager to move it. Add the following code and save: @@ -56,7 +64,7 @@ def test_multiply(): ### Commit your changes and push to GitHub -Once you've created your function and test files and added the line to import your function to `pythoncalculator/__init__.py`, commit your changes. +Once you've created your function and test files and added the line to import your function to `pythoncalculator/__init__.py`, commit your changes. Use `resolves #{ISSUE_NUMBER_YOU_WERE_ASSIGNED}` in your commit message to automatically close the issue when your pull request is merged. @@ -66,10 +74,10 @@ Then push them up to GitHub Finally, create a pull request back to the `main` branch on GitHub and wait for the owner's review. -Reference the issue your pull request refers to with `#{ISSUE_NUMBER_YOU_WERE_ASSIGNED}` in the description. +Reference the issue your pull request refers to with `#{ISSUE_NUMBER_YOU_WERE_ASSIGNED}` in the description. Respond to any requests for correction. ### Close issue -If the issue didn't close automatically, close it yourself. You can also +If the issue didn't close automatically, close it yourself. You can also diff --git a/.github/ISSUE_TEMPLATE/add-subtraction-function.md b/.github/ISSUE_TEMPLATE/add-subtraction-function.md index 62327e6..51e6121 100644 --- a/.github/ISSUE_TEMPLATE/add-subtraction-function.md +++ b/.github/ISSUE_TEMPLATE/add-subtraction-function.md @@ -22,25 +22,32 @@ Use this checklist to tick off sub-tasks as you complete them following these [s ### Create branch Create a new `subtract` branch from `main` to work in. + ### Add subtraction function -Create a new `subtract.py` file in the `pythoncalculator/` directory. +1. Use the command palette in GitKraken (ctrl+P or ⌘+P on a mac) to `create` a new file called `pythoncalculator/subtract.py` and add the following lines of code. ```python def subtract(x, y): return y - y ``` +> [!NOTE] Make sure your `subtract.py` file is within the `pythoncalculator` directory with the existing `add.py` file. +> If it's in the wrong place, use the system file manager to move it to the correct place. -Open the `pythoncalculator/__init__.py` file and add the following line of code: +2. Use the command palette in GitKraken to `edit` the `pythoncalculator/__init__.py` file and add the following line of code. ```python -from .subtract import subtract +from .subtract import subtract ``` +> [!NOTE] +> Do not delete the existing line of code from `pythoncalculator/__init__.py + ### Add subtraction test -Create a new `test_subtract.py` file in the `tests/` directory. +Use the command palette in GitKraken to `create` a new file called `tests/test_subtract.py`. +Again, if you accidentally create your file in the wrong place, use the system file manager to move it. Add the following code and save: @@ -55,7 +62,7 @@ def test_subtract(): ### Commit your changes and push to GitHub -Once you've created your function and test files and added the line to import your function to `pythoncalculator/__init__.py`, commit your changes. +Once you've created your function and test files and added the line to import your function to `pythoncalculator/__init__.py`, commit your changes. Use `resolves #{ISSUE_NUMBER_YOU_WERE_ASSIGNED}` in your commit message to automatically close the issue when your pull request is merged. @@ -65,10 +72,10 @@ Then push them up to GitHub Finally, create a pull request back to the `main` branch on GitHub and wait for the owner's review. -Reference the issue your pull request refers to with `#{ISSUE_NUMBER_YOU_WERE_ASSIGNED}` in the description. +Reference the issue your pull request refers to with `#{ISSUE_NUMBER_YOU_WERE_ASSIGNED}` in the description. Respond to any requests for correction. ### Close issue -If the issue didn't close automatically, close it yourself. You can also +If the issue didn't close automatically, close it yourself. You can also diff --git a/tests/__init__.py b/tests/__init__.py index e69de29..1d66fa1 100644 --- a/tests/__init__.py +++ b/tests/__init__.py @@ -0,0 +1,2 @@ +# DO NOT EDIT THIS FILE +# Are you looking for pythoncalculator/__init__.py?