Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
36 lines (29 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

36 lines (29 loc) · 1.22 KB

Contributing

Thanks for your interest in contributing! This project is a small CLI for managing Cloudflare DNS via their API. Here’s how to get started.

Code of Conduct

Please read and follow the Code of Conduct. We expect all contributors to uphold these standards.

Development Setup

  1. Clone the repo and enter the directory.
  2. (Optional) Create and activate a virtualenv: 
    python3 -m venv .venv && source .venv/bin/activate
  3. Install dependencies: 
    pip install -r requirements.txt

Running Lint

We use pylint for linting. Install it (if not already available) and run:

PYLINTHOME=.pylint.d pylint cfmanager.py

Making Changes

  • Keep changes focused; separate unrelated fixes into different pull requests.
  • Add or update documentation when behavior changes.
  • Avoid introducing new dependencies unless necessary; if you do, explain why.

Pull Requests

  1. Fork the repo and create a feature branch.
  2. Ensure lint passes and commands work as expected.
  3. Submit a PR using the template in .github/pull_request_template.md.
  4. Be responsive to review feedback; small, incremental updates are preferred.

Thank you for contributing!