58 lines (39 loc) · 1.3 KB

Contributing to Wayback Cache Proxy

Thank you for your interest in contributing!

Ways to Contribute

Report Bugs

Use the Issues tab
Include steps to reproduce
Mention your environment (OS, Python version, Redis version)

Suggest Features

Open an issue with enhancement label
Describe the use case

Submit Code

Fork the repository
Create a branch: git checkout -b feature/your-feature
Make changes following code style
Test your changes
Commit: git commit -m "Add feature: description"
Push: git push origin feature/your-feature
Open a Pull Request

Code Style

Python

Follow PEP 8
Use type hints
Document with docstrings

JavaScript (header bar, admin UI)

Must be compatible with old browsers (IE5+)
No addEventListener, querySelector, const/let, arrow functions
Use document.getElementById, onclick, var, innerHTML
Wrap in  HTML comment for script hiding

Commit Messages

Present tense: "Add feature" not "Added feature"
Reference issues: "Fix #123: Handle edge case"

License

By contributing, you agree your contributions will be licensed under the project's MIT License.

Thank you for helping improve ZKM open source!