Skip to content

Latest commit

 

History

History
44 lines (32 loc) · 1.07 KB

CONTRIBUTING.md

File metadata and controls

44 lines (32 loc) · 1.07 KB

Contributing to dns-updater

Thank you for considering contributing to dns-updater! This is a simple guide to help you get started.

How to Contribute

  1. Fork the repository
  2. Create a new branch for your feature or fix
  3. Make your changes
  4. Test your changes
  5. Submit a Pull Request

Guidelines

Code Style

  • Use clear and descriptive variable names
  • Add comments for complex logic
  • Follow Go standard formatting (use go fmt)

Commits

  • Use clear commit messages or make sure to squash and merge
  • Keep commits focused on single changes
  • Reference issue numbers if applicable

Pull Requests

  • Describe what your changes do
  • Mention any breaking changes
  • Update documentation if needed

Testing

  • Add tests for new features (if it makes sense)
  • Ensure existing tests pass
  • Test your changes locally before submitting

Development Setup

  1. Clone the repository
  2. Copy config.yaml.example to config.yaml
  3. Add your API credentials to config.yaml
  4. Run go build to compile

Questions?

Feel free to open an issue for any questions or concerns.