From 9c326d809ac31fd14f2b7cdf792b6a9f70916978 Mon Sep 17 00:00:00 2001 From: Aaditya-ops-cpu Date: Thu, 8 Jan 2026 15:18:33 +0530 Subject: [PATCH 1/2] Update README.md with contribution section --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 32ead01746..544c413375 100644 --- a/README.md +++ b/README.md @@ -381,6 +381,25 @@ The `standard` extra dependencies are `rich` and `shellingham`. **Note**: The `typer` command is only included in the `typer` package. +## Contributing + +We welcome contributions of all kinds (\*v*) : +1) Documentation improvements - good for beginners +2) Bug fixes - AFTER GAINING EXPERIENCE AND LEARNING CODEBASE ONLY :) +3) New features - Same as above +4) Tests - Always welcome (\*v*) +5) Typo fixes - Show your english mastery (._.) + +### Development Setup +1. Fork the repository +2. Create a virtual environment +3. Merge your changes if accepted (: + +### Pull Request Guidelines +Keep PRs focused +Add tests for new features +Update documentation if behavior changes ( otherwise you can face linting issues (;;)) + ## License This project is licensed under the terms of the MIT license. From 34ea20c5001c81e37a91fbc60e9c23e055a49651 Mon Sep 17 00:00:00 2001 From: Aaditya-ops-cpu Date: Thu, 8 Jan 2026 15:19:29 +0530 Subject: [PATCH 2/2] Update index.md with contribution section --- docs/index.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/index.md b/docs/index.md index 31baa86594..b8aaa0e047 100644 --- a/docs/index.md +++ b/docs/index.md @@ -387,6 +387,25 @@ The `standard` extra dependencies are `rich` and `shellingham`. **Note**: The `typer` command is only included in the `typer` package. +## Contributing + +We welcome contributions of all kinds (\*v*) : +1) Documentation improvements - good for beginners +2) Bug fixes - AFTER GAINING EXPERIENCE AND LEARNING CODEBASE ONLY :) +3) New features - Same as above +4) Tests - Always welcome (\*v*) +5) Typo fixes - Show your english mastery (._.) + +### Development Setup +1. Fork the repository +2. Create a virtual environment +3. Merge your changes if accepted (: + +### Pull Request Guidelines +Keep PRs focused +Add tests for new features +Update documentation if behavior changes ( otherwise you can face linting issues (;;)) + ## License This project is licensed under the terms of the MIT license.