litmuschaos / litmuschaos/litmus-python

Creating and Customizing Chaos Experiments with LitmusChaos SDK – Sample Experiment Creation Steps for the Contribute Guide

Open
#53 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
17
Forks
20
PR merge metrics
No merged PRs in 30d

Description

DoD:
- Create a guide page named sample-experiment-generation.md in [this location](https://github.com/litmuschaos/litmus-python/tree/master/contribute/developer-guide).
- Follow the [referenced blog ](https://dev.to/oumkale/create-chaos-experiments-using-the-litmuschaos-python-sdk-4492/edit)to generate a sample experiment.
- Refactor the experiment to follow standard conventions.
- Document the steps clearly in the guide.
- Ensure the content is easy to understand for new contributors.
- Add the finalized content to the specified location in the repository.

Contributor guide

Open the contributing guide

Research direction

Start by reading the referenced LitmusChaos Python SDK blog and reviewing the contribute/developer-guide location. Create sample-experiment-generation.md, document the sample experiment creation steps, refactor the experiment to follow standard conventions, and ensure the guide is clear for new contributors.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.