Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (37 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

51 lines (37 loc) · 1.74 KB

Contributing to The Ultimate Google Ads Scripts Collection

Thank you for your interest in contributing! This collection thrives on community input.

How to Contribute

Submitting a New Script

  1. Fork this repository
  2. Create a feature branch: git checkout -b add-my-script
  3. Add your script to the appropriate category folder under scripts/
  4. Ensure your script includes:
    • A header comment block with description, author, and version
    • A CONFIG object for user-configurable settings
    • Inline comments explaining key logic
    • Error handling for common failure modes
  5. Update the category README.md in the script's folder
  6. Submit a Pull Request with a clear description

Script Quality Standards

All scripts should:

  • Be standalone .js files that run directly in Google Ads Scripts
  • Use AdsApp (not the deprecated AdWordsApp)
  • Include a main() function as the entry point
  • Have a CONFIG section at the top with clearly documented options
  • Handle errors gracefully (try/catch, logging)
  • Not expose credentials, API keys, or personal information

Reporting Issues

  • Use GitHub Issues for bug reports
  • Include the script name, error message, and steps to reproduce
  • Note your Google Ads account type (single account vs MCC)

Improving Documentation

  • Wiki improvements are always welcome
  • Fix typos, add examples, or expand installation guides
  • Translate documentation to other languages

Code Style

  • Use const and let (not var) where supported
  • Prefer descriptive variable and function names
  • Keep functions focused and under 50 lines where possible
  • Use JSDoc-style comments for function documentation

License

By contributing, you agree that your contributions will be licensed under GPL-2.0.