Skip to content

Commit dc8b85a

Browse files
committed
chore(docs): squash-merge docs/update-md-files — Added md files
1 parent 1087543 commit dc8b85a

File tree

5 files changed

+354
-42
lines changed

5 files changed

+354
-42
lines changed

CHANGELOG.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
5+
6+
---
7+
8+
## [0.0.1] - 2025-09-25
9+
10+
### Added
11+
- Initial release of **show-file-tree**.
12+
- Core functionality: build and display styled file/folder trees directly in the terminal.
13+
- CLI flags:
14+
- `-d, --max-depth` → Limit recursion depth.
15+
- `--gitignore / --no-gitignore` → Respect or ignore `.gitignore` files.
16+
- `--hidden` → Show hidden files and directories.
17+
- `--sort {name,size}` → Sort tree output by name or size.
18+
- `--order {asc,desc}` → Control sorting order.
19+
- `--size` → Display file/folder sizes.
20+
- `--count` → Show file/directory counts inside folders.
21+
- `--format {tree,md}` → Output format (tree in terminal or export to Markdown).
22+
- `--theme {colorful, monokai, light, nocolor}` → Apply custom color themes.
23+
- `--no-icons` → Render plain ASCII trees without icons.
24+
- `--mtime-after`, `--mtime-before` → Filter files/folders by modification time.
25+
- `--ctime-after`, `--ctime-before` → Filter files/folders by creation time.
26+
- `--include`, `--exclude` → Filter paths by glob patterns.
27+
- General commands:
28+
- `--version` → Show package version.
29+
- `--about` → Show package information.
30+
31+
32+

CODE_OF_CONDUCT.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Code of Conduct
2+
3+
Thank you for contributing to **show-file-tree**!
4+
We want this project to be welcoming, safe, and inclusive for everyone.
5+
6+
## Our Standards
7+
8+
We are committed to providing a friendly environment where everyone can:
9+
10+
- Be **respectful** and **kind** in all interactions.
11+
- Accept constructive feedback with an open mind.
12+
- Help others learn and grow by sharing knowledge.
13+
- Focus on what is best for the community and project.
14+
15+
Unacceptable behaviors include:
16+
17+
- Disrespectful or offensive comments.
18+
- Personal attacks or harassment.
19+
- Spamming, trolling, or disruptive behavior.
20+
- Sharing malicious or harmful content.
21+
22+
## How to Report Issues
23+
24+
If you see behavior that violates this Code of Conduct:
25+
26+
- Open an issue on GitHub **OR**
27+
- Contact the maintainer directly
28+
29+
All reports will be reviewed and handled confidentially.
30+
31+
## Enforcement
32+
33+
- Violations may result in warnings, temporary bans, or permanent bans from the project, depending on severity.
34+
- The maintainer reserves the right to enforce this Code of Conduct.
35+
36+
## Acknowledgement
37+
38+
This Code of Conduct is inspired by the [Contributor Covenant](https://www.contributor-covenant.org/) but kept short and simple for this project.

CONTRIBUTING.md

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
# Contributing to show-file-tree
2+
3+
First off, thank you for considering contributing! Your help is greatly appreciated 🙌
4+
5+
This document outlines the guidelines and best practices for contributing to **show-file-tree**, a small but powerful CLI tool for visualizing file and folder structures.
6+
7+
---
8+
9+
## 🚀 How Can I Contribute?
10+
11+
### Reporting Bugs
12+
- First, check if the bug has already been reported under **GitHub Issues**.
13+
- If not, open a new issue with:
14+
- A **clear title and description**.
15+
- Steps to reproduce the issue.
16+
- A minimal code sample or test case showing the problem.
17+
- Expected vs actual behavior.
18+
19+
### Suggesting Enhancements
20+
- Open a new issue with your enhancement idea.
21+
- Provide:
22+
- A **clear description** of the proposed enhancement.
23+
- The **benefit** it brings to users.
24+
- Example use cases, if possible.
25+
26+
### Pull Requests
27+
1. **Fork the repo** and create your branch from `main`.
28+
2. **Set up your development environment**:
29+
30+
```
31+
# Clone your fork
32+
git clone https://github.com/YOUR_USERNAME/show-file-tree.git
33+
cd show-file-tree
34+
```
35+
36+
```
37+
# Create a virtual environment and activate it
38+
python -m venv .venv
39+
source .venv/bin/activate # (Linux/macOS)
40+
.venv\Scripts\activate # (Windows PowerShell)
41+
```
42+
43+
```
44+
# Install dependencies for development
45+
pip install -e ".[all]"
46+
pip install pytest
47+
```
48+
49+
3. **Make changes** and add tests for your feature or bug fix.
50+
4. Run the test suite: [**pytest**](https://github.com/pytest-dev/pytest)
51+
5. Format your code with [**Black**](https://github.com/psf/black) or [**Ruff**](https://github.com/astral-sh/ruff).
52+
6. Commit your changes with a clear message.
53+
7. Push your branch and **open a Pull Request** (PR).
54+
55+
---
56+
57+
## 📝 Branching Convention
58+
59+
| Prefix | Purpose | Example Branch Name |
60+
| ----------- | ----------------------------------------- | ----------------------- |
61+
| `feature/` | New features or functionality | `feature/add-cli-tree` |
62+
| `fix/` | Bug fixes or small corrections | `fix/fix-path-handling` |
63+
| `docs/` | Documentation changes | `docs/update-readme` |
64+
| `wip/` | Work-in-progress experiments | `wip/template` |
65+
| `chore/` | Misc tasks like setup, CI, configs | `chore/add-gitignore` |
66+
| `refactor/` | Code restructuring without feature change | `refactor/cleanup-code` |
67+
68+
---
69+
70+
## ✅ Coding Standards
71+
72+
* Follow **[PEP 8](https://peps.python.org/pep-0008/)** style guidelines.
73+
* Keep functions small, modular, and well-structured.
74+
* Add **docstrings** to all public modules, functions, classes, and methods.
75+
* Write **clear, readable commit messages**:
76+
77+
* `Add: new feature xyz`
78+
* `Fix: bug in path handling`
79+
* `Docs: update contributing guide`
80+
81+
---
82+
83+
## 🧪 Testing
84+
85+
* Add or update tests for any new code.
86+
* Run the full test suite with:
87+
88+
```bash
89+
pytest
90+
```
91+
* Ensure all tests pass before submitting a PR.
92+
93+
---
94+
95+
## 🙌 Ways to Contribute
96+
97+
* Report bugs
98+
* Suggest enhancements
99+
* Submit pull requests (features, bug fixes, documentation)
100+
* Improve docs (README, examples, etc.)
101+
102+
---
103+
104+
## 📄 License
105+
106+
By contributing, you agree that your contributions will be licensed under the same license as this project (MIT).
107+

0 commit comments

Comments
 (0)