Skip to content
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.

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

Create a dev container to make development easier #175

Closed
refeed opened this issue Sep 10, 2024 · 1 comment
Closed

Create a dev container to make development easier #175

refeed opened this issue Sep 10, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@refeed
Copy link
Member

refeed commented Sep 10, 2024

Is your feature request related to a problem? Please describe.
Usually new developers, they have a hard time for contributing especially the first time because they need to set up their own development environment. The current process might look simple, but in reality it's much more complex than that, one of the most often problems that I encountered when doing this kind of setup is OS difference, people using Windows will have a different steps of setting it up with those who are using Linux based distro or even Mac.

Describe the solution you'd like
Dev container has been around for sometime to solve this problem.

Describe alternatives you've considered
Another way is using vagrant to spin up a VM inside the contributor's machine, but this is not preferable as it is consuming too much resources compared to dev container.

Additional context
No

@refeed refeed added enhancement New feature or request help wanted Extra attention is needed labels Sep 10, 2024
@AkashS0510
Copy link
Collaborator

@refeed Kindly assign this to me

AkashS0510 added a commit to AkashS0510/tirith that referenced this issue Sep 23, 2024
AkashS0510 added a commit to AkashS0510/tirith that referenced this issue Sep 23, 2024
Add dev container

Closes StackGuardian#175
AkashS0510 added a commit to AkashS0510/tirith that referenced this issue Sep 23, 2024
Add dev container

Closes StackGuardian#175

Update Readme.MD
AkashS0510 added a commit to AkashS0510/tirith that referenced this issue Sep 23, 2024
Add dev container

Closes StackGuardian#175

Update Readme.MD
AkashS0510 added a commit to AkashS0510/tirith that referenced this issue Sep 23, 2024
Add dev container

Closes StackGuardian#175

Update Readme.MD
AkashS0510 added a commit to AkashS0510/tirith that referenced this issue Sep 23, 2024
Add dev container

Closes StackGuardian#175

Update Readme.MD

Revert "Add dev container"

This reverts commit c6e4f31.
AkashS0510 added a commit to AkashS0510/tirith that referenced this issue Sep 23, 2024
Add dev container

Closes StackGuardian#175

Update Readme.MD
AkashS0510 added a commit to AkashS0510/tirith that referenced this issue Sep 23, 2024
Add dev container

Closes StackGuardian#175

Update Readme.MD
AkashS0510 added a commit to AkashS0510/tirith that referenced this issue Sep 24, 2024
Add dev container

Closes StackGuardian#175

Update Readme.MD
AkashS0510 added a commit to AkashS0510/tirith that referenced this issue Sep 25, 2024
Add dev container

Closes StackGuardian#175

Update Readme.MD
samriddhi99 pushed a commit to AkashS0510/tirith that referenced this issue Sep 25, 2024
Add dev container

Closes StackGuardian#175

Update Readme.MD
tejasvi541 added a commit to tejasvi541/tirith-local that referenced this issue Oct 4, 2024
Fix: corrected the file name __init__.py

Signed-off-by: pravo23 <[email protected]>

Enhance GitHub Actions Workflow with PR Triggers (StackGuardian#148)

* Add PR triggers to github actions workflow

* Update lint.yml
Centralized version definition to simplify version management (StackGuardian#142)

Co-authored-by: Rafid Aslam <[email protected]>
Update build_test.yml (StackGuardian#149)

* Update build_test.yml

* Update lint.yml
Update logger initialization to use module-specific loggers StackGuardian#140

Changed "logger = logging.getLogger()" line of code to "logger = logging.getLogger(__name__)" in all files

Removed the TODO Comments - "# TODO: At least add __name__ as the name for the logger" in all files
StackGuardian#140

Removed RESULTS text from error

Resolved - Generalize the function get_path_value_from_dict

Refactor get_path_value_from_dict

Moved get_path_value_from_dict to common.py.
Refactored Kubernetes and JSON handler files to import from common.py.

Updated Common.py

Fix linting (StackGuardian#167)

Add a getting started guide in README.md (StackGuardian#139)

* Add a getting started guide in README.md

* Add description of getting started activity, and some minor fixes
Add maintainers in README and CODEOWNERS file

Add additional rules and guidelines to contributing.md

Add examples for commit messages and guidelines for solving issues

Update CONTRIBUTING.md with guidelines about solving issues

Add separate heading about solving issues, and add examples for writing descriptions in commit changes
setup the docs base (StackGuardian#177)

* created the template for the official documentation

* setting up the environment

* cleaned up the documentation setup

* adjusted the color scheme

* setup the basic pages for the tirith documentation

* updated the intro page
Add dev container

Add dev container

Closes StackGuardian#175

Update Readme.MD

Simplify type checking in sort_collections()

Closes StackGuardian#185

Add Variable Replacement Support in Tirith Policies (StackGuardian#171)

* Add support for parameterizing Tirith policies

* Use pydash.get() and check for match only if the value is of type str

* Add variable replacement for meta and eval_expression in a policy

* Add unit tests for policy parameterization, change return type for cases where the path was not found, and change syntax of entering the variable names

* Fix linting

* tirith parametrization

---------

Co-authored-by: Rafid Aslam <[email protected]>
Removed RESULTS text from error

Resolved - Generalize the function get_path_value_from_dict

Refactor get_path_value_from_dict

Moved get_path_value_from_dict to common.py.
Refactored Kubernetes and JSON handler files to import from common.py.

Updated Common.py

Fix linting (StackGuardian#167)

Add a getting started guide in README.md (StackGuardian#139)

* Add a getting started guide in README.md

* Add description of getting started activity, and some minor fixes
Add maintainers in README and CODEOWNERS file

Add additional rules and guidelines to contributing.md

Add examples for commit messages and guidelines for solving issues

Update CONTRIBUTING.md with guidelines about solving issues

Add separate heading about solving issues, and add examples for writing descriptions in commit changes

Merge branch 'main' of https://github.com/StackGuardian/tirith
refeed pushed a commit that referenced this issue Oct 15, 2024
* Requested Changes

- Changed some variable names to snake case

- Removed unused imports from cli.py

- Added Some dev dependencies like autopep8 and pylint for effective searches will remove before final commit

- Added a custom py file to filter pylint logs, will remove before final commit

* removed filter script and logs, and changed names where's its needed

* Add installation instruction to README.md

Fix: corrected the file name __init__.py

Signed-off-by: pravo23 <[email protected]>

Enhance GitHub Actions Workflow with PR Triggers (#148)

* Add PR triggers to github actions workflow

* Update lint.yml
Centralized version definition to simplify version management (#142)

Co-authored-by: Rafid Aslam <[email protected]>
Update build_test.yml (#149)

* Update build_test.yml

* Update lint.yml
Update logger initialization to use module-specific loggers #140

Changed "logger = logging.getLogger()" line of code to "logger = logging.getLogger(__name__)" in all files

Removed the TODO Comments - "# TODO: At least add __name__ as the name for the logger" in all files
#140

Removed RESULTS text from error

Resolved - Generalize the function get_path_value_from_dict

Refactor get_path_value_from_dict

Moved get_path_value_from_dict to common.py.
Refactored Kubernetes and JSON handler files to import from common.py.

Updated Common.py

Fix linting (#167)

Add a getting started guide in README.md (#139)

* Add a getting started guide in README.md

* Add description of getting started activity, and some minor fixes
Add maintainers in README and CODEOWNERS file

Add additional rules and guidelines to contributing.md

Add examples for commit messages and guidelines for solving issues

Update CONTRIBUTING.md with guidelines about solving issues

Add separate heading about solving issues, and add examples for writing descriptions in commit changes
setup the docs base (#177)

* created the template for the official documentation

* setting up the environment

* cleaned up the documentation setup

* adjusted the color scheme

* setup the basic pages for the tirith documentation

* updated the intro page
Add dev container

Add dev container

Closes #175

Update Readme.MD

Simplify type checking in sort_collections()

Closes #185

Add Variable Replacement Support in Tirith Policies (#171)

* Add support for parameterizing Tirith policies

* Use pydash.get() and check for match only if the value is of type str

* Add variable replacement for meta and eval_expression in a policy

* Add unit tests for policy parameterization, change return type for cases where the path was not found, and change syntax of entering the variable names

* Fix linting

* tirith parametrization

---------

Co-authored-by: Rafid Aslam <[email protected]>
Removed RESULTS text from error

Resolved - Generalize the function get_path_value_from_dict

Refactor get_path_value_from_dict

Moved get_path_value_from_dict to common.py.
Refactored Kubernetes and JSON handler files to import from common.py.

Updated Common.py

Fix linting (#167)

Add a getting started guide in README.md (#139)

* Add a getting started guide in README.md

* Add description of getting started activity, and some minor fixes
Add maintainers in README and CODEOWNERS file

Add additional rules and guidelines to contributing.md

Add examples for commit messages and guidelines for solving issues

Update CONTRIBUTING.md with guidelines about solving issues

Add separate heading about solving issues, and add examples for writing descriptions in commit changes

Merge branch 'main' of https://github.com/StackGuardian/tirith
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants