Skip to content

Commit

Permalink
Test github actions (#9)
Browse files Browse the repository at this point in the history
* Test github actions

* test github actions
  • Loading branch information
vyshnav-vinod authored Mar 22, 2024
1 parent d272b2e commit b57e285
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 2 deletions.
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -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 <[email protected]>"]
license = "MIT"
Expand Down
2 changes: 1 addition & 1 deletion tests/test_parser.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
25 changes: 25 additions & 0 deletions tests/todo_test.txt
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit b57e285

Please sign in to comment.