diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..519df02 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +To setup `getodo` for contributing, follow these steps + +- [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) the repository and then [clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) it + +- Navigate into the cloned repository + +- Create a python [virtual environment](https://docs.python.org/3/tutorial/venv.html) [OPTIONAL] + +- You can either use ```pip install -r requirements_dev.txt``` or `poetry install` to install the required libraries. + +- It is recommended that you create a branch for the bug fix/feature ``` git branch feature_name``` and then work on it ```git checkout feature_name``` + +- After finishing the work, run the tests by simply using the pytest command +```pytest``` + +- Make sure tests pass and then make a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) + +> [!NOTE] +> If you feel stuck or confused, don't hesitate to open a new issue. :) I will be happy to help diff --git a/pyproject.toml b/pyproject.toml index 158d677..36c975b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "getodo" -version = "1.0.0" +version = "1.0.1" description = "A python program to collect all your TODO(s)" authors = ["vyshnav-vinod "] license = "MIT" diff --git a/tests/test_parser.py b/tests/test_parser.py index 3d33db0..1d373e1 100644 --- a/tests/test_parser.py +++ b/tests/test_parser.py @@ -13,7 +13,7 @@ def test_parser(self, tmp_path): self.cpp_content = file.read() with open("tests/other_content.txt", "r") as file: self.other_content = file.read() - with open("tests/todo.txt", "r") as file: + with open("tests/todo_test.txt", "r") as file: self.expected_output = file.read() self.file1 = tmp_path / "file1.py" diff --git a/tests/todo_test.txt b/tests/todo_test.txt new file mode 100644 index 0000000..41ddf35 --- /dev/null +++ b/tests/todo_test.txt @@ -0,0 +1,25 @@ + +{} : + +Line 8 - TODO: This is test 1 +Line 9 - TODO : This is test 2 + +{} : + +Line 6 - TODO: This is test 1 +Line 7 - TODO : This is test 2 + +{} : + +Line 6 - TODO: This is test 1 +Line 7 - TODO : This is test 2 + +{} : + +Line 6 - TODO: This is test 1 +Line 7 - TODO : This is test 2 + +{} : + +Line 8 - TODO: This is test 1 +Line 9 - TODO : This is test 2