Skip to content

Updated README.md and index.md with contribution section #1486

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.

Sign up for GitHub

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

Closed
Aaditya-ops-cpu wants to merge 2 commits into from
+38 −0
Closed

Updated README.md and index.md with contribution section #1486

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9c326d8
Update README.md with contribution section
Aaditya-ops-cpu Jan 8, 2026
34ea20c
Update index.md with contribution section
Aaditya-ops-cpu Jan 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
19 changes: 19 additions & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.