Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 2.96 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 2.96 KB
Raw

Contributing to ttk file explorer

First and foremost, thank you for your interest and contribution to the ttk file explorer project! We warmly welcome and greatly appreciate any form of participation, regardless of its size. Here are some guidelines on how you can contribute to the project.

What You Can Contribute Reporting

Issues or Providing

SuggestionsIf you encounter any issues while using ttk file explorer, or have any suggestions or ideas related to the project, please create an issue on GitHub. When creating an issue, please provide a detailed description, including the steps you took to encounter the problem, your operating system, Python version, and other relevant information. This will help us locate and resolve the issue more quickly.

Documentation

Contributions Documentation is a crucial part of the project, as it helps users understand how to use and comprehend the project. You can contribute to the documentation in the following ways:

  • Modifying MD Files: If you find any spelling errors, grammatical errors, or areas for improvement, please directly modify the corresponding Markdown files and submit a Pull Request.
  • Enhancing the Official Website Files: You can help refine the official website files in the docs folder, including adding descriptions of new features, updating user guides, and more.

Code Contributions

If you'd like to contribute through coding, that's fantastic! Here are some guidelines for code contributions:

  • Selecting an Issue or Feature: You can choose an issue from the existing ones that interests you to fix, or propose a new feature and implement it.
  • Creating a Pull Request: Once you've completed coding and testing, you can create a Pull Request. Before submitting the Pull Request, please ensure that your code follows the existing coding style of the project.
  • Waiting for Review and Merging: Your Pull Request will be reviewed by project members. If the code is sound and meets the project's needs and standards, it will be merged into the main branch.

Becoming a Contributor

Once your Pull Request is merged into the main branch, you will become an official contributor to ttk file explorer, and your name will be displayed in the software's list of contributors. We are deeply grateful for your dedication and contribution!

How to Get Started

  1. Fork the Repository: First, you need to fork our repository to your personal account on GitHub.
  2. Clone the Repository: Clone the forked repository to your local machine.
  3. Create a Branch: Create a new branch on your local machine for your development work.
  4. Write Code or Documentation: Perform code writing or documentation modifications on your branch.
  5. Commit Changes: Commit your changes to Git and push them to your remote repository.
  6. Create a Pull Request: On GitHub, create a Pull Request to merge your changes into the main branch.

Thank you again for your contribution to the ttk file explorer project! We eagerly await your participation!