-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Test github actions * test github actions
- Loading branch information
1 parent
d272b2e
commit b57e285
Showing
4 changed files
with
46 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |