Skip to content

Latest commit

 

History

History
74 lines (45 loc) · 3.35 KB

README.md

File metadata and controls

74 lines (45 loc) · 3.35 KB
Raw

📚 Documentation overview

Welcome to the documentation section, here you will find all the necessary documentation.

🏴 Translations of this file

📚 Table of contents

📥 Installation

📥 Configuration

🐛 Debugging help & tips

👨‍💻 Development priorities

Priorities from highest to lowest:

  • 🔼 Fixing core functionality bugs not solvable with workarounds
  • 🔵 New core functionality unlocking other opportunities (e.g.: plugins)
  • 🔵 Refactoring enabling faster implementation of future functionality
  • 🔽 (low) UI functionality & improvements (PRs welcome 😉)

Design philosophy: Focus on core functionality and leverage existing apps and tools to make Cloudflare-CLI integrate into other workflows.

Examples:

1. Supporting apprise makes more sense than implementing multiple individual notification gateways
2. Implementing regular expression support across settings for validation makes more sense than validating one setting with a specific expression.

UI-specific requests are a low priority as the framework picked by the original developer is not very extensible (and afaik doesn't support components) and has limited mobile support. Also, I argue the value proposition is smaller than working on something else.

Feel free to submit PRs if interested. try to keep the PRs small/on-topic so they are easier to review and approve.

That being said, I'd reconsider if more people and or recurring sponsors file a request 😉.

🙏 Feature requests

Please be as detailed as possible with workarounds you considered and why a native feature is the better way. This gives me better context and will make it more likely to be implemented. Ideally, a feature request should be in the format "I want to be able to do XYZ so that ZYX. I considered these approaches XYZ".

➕ Pull requests (PRs)

If you submit a PR please:

  1. Check that your changes are backward compatible with existing installations and with a blank setup.
  2. Existing features should always be preserved.
  3. Keep the PR small, on-topic and don't change code that is not necessary for the PR to work
  4. New features code should ideally be re-usable for different purposes, not be for a very narrow use-case.
  5. New functionality should ideally be implemented via the Plugins system, if possible.

🐛 Submitting an issue or bug

Before submitting a new issue please spend a couple of minutes on research:

⚠ Please follow the pre-defined issue template to resolve your issue faster.