Contribution Guide

Contributors Wall

Thanks to Every Contributor

Your participation makes ttk file explorer better!

Become a Contributor

1. Submit a PR
   After your PR is merged

2. Join the List
   Become an official contributor

3. Showcase Achievement
   Listed on the Contributors Wall

Contribution Methods

• Report Issues or Suggestions
  Create GitHub Issues · Provide detailed descriptions · Include relevant environment information

• Documentation Contributions
  Modify Markdown files · Correct errors, improve quality · Update feature descriptions and guides

• Code Contributions
  Select existing issues or new features · Follow PEP8 coding standards · Create Pull Requests

• Other Contributions
  Even small contributions matter! Any fixes and improvements are appreciated.

Getting Started

graph LR
  A[Fork Repository] --> B[Clone Repository]
  B --> C[Create New Branch]
  C --> D[Write Code/Docs]
  D --> E[Commit & Push]
  E --> F[Create PR]

1. Fork Repository

   Visit GitHub repository and click Fork button

2. Clone Repository
   

   git clone https://github.com/pyheight/ttk-file-explorer.git
   cd ttk-file-explorer
   

3. Create New Branch
   

   git checkout -b feature/your-feature-name
   

4. Write Code or Documentation

   Code modifications in src/ directory
   Documentation modifications in docs/ directory

5. Commit & Push
   

   git add .
   git commit -m "Describe your changes"
   git push origin feature/your-feature-name
   

6. Create Pull Request

   Click New Pull Request button on GitHub repository page

Contribution Standards

• Coding Style
  Follow PEP8 standards.

• Documentation Requirements
  All new features require accompanying documentation.

• Testing Requirements
  Core features must include unit tests.

• Commit Messages
  Clearly describe changes.

More References

• Full Contribution Guide

• Good First Issues

• Submit Any Questions, Suggestions, or Ideas

Tip

Looking forward to your contributions!