Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
104 lines (71 loc) · 3.97 KB

CONTRIBUTING.md

File metadata and controls

104 lines (71 loc) · 3.97 KB
Raw

Contribution Guidelines

简体中文 | English

First and foremost, thank you for considering contributing to VCF Generator Lite!

We welcome contributions of any kind, whether it's reporting issues, suggesting improvements, fixing bugs, or adding new features.

Tip

If you're new to open source contributions, these resources might help you:

Code of Conduct

When participating in this project, please abide by our Contributor Covenant. We are committed to providing a friendly and inclusive community environment for everyone.

How to Contribute

Submitting Issues or Suggestions

If you encounter problems or have improvement suggestions while using the application, feel free to submit feedback through any of the following channels:

Localizing the Application

Localization work includes adding phone detectors to support more number types, and translating application interface texts (including phone detector names).

Tip

Using AI-Assisted Localization

If you're unfamiliar with code or translation file formats, you can leverage modern AI tools like GitHub Copilot or Trae. Simply describe your needs in natural language, and the AI will automatically generate compliant code or complete translations.

Detailed guides for each task:

Participating in Development

  1. Ensure there are no related pull requests (PRs) in the Gitee repository or GitHub repository.
  2. Fork this repository.
  3. Clone the repository locally using Git.
  4. Read the Development Guide to familiarize yourself with the project's development practices.
  5. Create a branch, such as feature/xxx or bugfix/xxx.
  6. Write your code.
  7. Run the following commands to ensure the code complies with standards and introduces no errors: 
    uv run poe format
uv run poe check
uv run poe test
  8. Commit your code.
  9. Submit a PR to this repository.

Standards

Code Standards

Python Code (.py)

  • Function parameters must have type annotations.
  • Maximum line length is 120 characters.
  • For all other cases, follow PEP 8.

Markdown Documents (.md)

  • No maximum line length restriction.
  • Refer to .markdownlint.json for specific rules.
  • For all other cases, follow Markdownlint.

For more details, refer to .editorconfig.

Documentation Standards

Follow the Chinese Technical Documentation Style Guide.

Documentation is organized using the Diátaxis framework into four categories: Tutorials, How-to guides, Reference, and Explanation.

Git Commit Standards

Follow Conventional Commits.