Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (40 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

61 lines (40 loc) · 1.82 KB
Raw

Contributing to ZPTTLink

Thank you for your interest in contributing to ZPTTLink! We welcome contributions from the community and want to make the process clear and straightforward.

Ways to Contribute

  • Report bugs or request features using GitHub Issues.
  • Improve documentation (README, code comments, examples).
  • Submit Pull Requests (PRs) with bug fixes, improvements, or new features.

Code Style

  • Follow PEP 8 (Python style guide) for clean, consistent code.
  • Add comments where needed for clarity.
  • Use docstrings for all functions, classes, and modules.
  • Keep things simple (KISS principle).

Pull Request Guidelines

  1. Fork the repository.
  2. Create a new branch for your feature or bugfix: 
    git checkout -b feature/my-new-feature
  3. Commit changes with clear, descriptive messages.
  4. Ensure code runs and does not break existing functionality.
  5. Open a Pull Request and describe your changes.

Tests

  • Please test your changes locally before submitting a PR.
  • If possible, add automated tests for new features.

Community

We value respectful collaboration. By contributing, you agree to follow our Code of Conduct (included below).

Contributor Covenant Code of Conduct

Our Pledge

We pledge to make participation in our community a harassment-free experience for everyone.

Our Standards

Examples of behavior that contributes to a positive environment:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints
  • Gracefully accepting constructive criticism

Examples of unacceptable behavior:

  • Harassment, trolling, or personal attacks
  • Publishing others’ private information

Enforcement

Instances of abusive behavior may be reported by contacting the project maintainer.

Thank you for helping make this project welcoming!