diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..a5fe755 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,41 @@ +# Pull Request + +## Description + +Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. Add screenshots to help describe the problem or your solution. + +Fixes # (issue) + +## Type of change + +Please delete options that are not relevant. + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update + +## How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration. + +- [ ] Test A +- [ ] Test B + +## Checklist: + +Before you submit this PR, please check off items you have completed: + +- [ ] I have read the [CONTRIBUTING.md](CONTRIBUTING.md) document +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes +- [ ] Any dependent changes have been merged and published in downstream modules + +## Additional context + +Add any other context or screenshots about the pull request here. diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..8a17f89 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,49 @@ +## v0.4.0 - Jul 24, 2026 + +OpenAPI 1.21.2: + +- Added workflow write APIs: `CreateWorkflow`, `UpdateWorkflow`, `ChangeWorkflowMailingList`, `CreateWorkflowNode`, `UpdateWorkflowNode`, `AddWorkflowBranch`, `DeleteWorkflowNode`, and `DeleteWorkflowNodeRecursive`. +- Added `ListEventPatterns`, `GetEventPattern`, and `GetEventPatternByName`. +- Added `CreateAudienceSegment`. +- Added `CreateTheme` / `UpdateTheme` and `CreateComponent` / `UpdateComponent`. +- Added `GetEmailMessageGuardian` and extra email message update fields. +- Fixed workflow node fields to match the OpenAPI spec. + +## v0.3.1 - Jun 24, 2026 + +- Added workflow read APIs: `ListWorkflows`, `GetWorkflow`, and `GetWorkflowNode`. +- Added `Client.Do` as a low-level escape hatch for endpoints without dedicated methods. + +## v0.3.0 - Jun 18, 2026 + +- Added campaign and transactional updates from OpenAPI 1.12.0. +- Added dedicated sending IP endpoints. +- SDK version is now resolved from build info when imported as a dependency. + +## v0.2.0 - Jun 9, 2026 + +Added support for transactional email management (`/api/v1/transactional-emails`). + +## v0.1.5 - May 26, 2026 + +Added Go package documentation. + +## v0.1.4 - May 26, 2026 + +Added support for `/uploads`, including the `Upload` helper. + +## v0.1.3 - May 5, 2026 + +Added themes API. + +## v0.1.2 - May 5, 2026 + +Added components API. + +## v0.1.1 - Apr 30, 2026 + +Installed govulncheck via mise to keep the SDK's dependencies clean. + +## v0.1.0 - Apr 30, 2026 + +Initial release. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..a545f08 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,132 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +- Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +- The use of sexualized language or imagery, and sexual attention or advances of + any kind +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email address, + without their explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official email address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[INSERT CONTACT METHOD]. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..cfb276e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,51 @@ +# Contributing to Loops Go SDK + +Thank you for your interest in contributing to Loops Go SDK. We welcome contributions from the community and are excited to see what you'll bring to the project. + +## Getting Started + +1. Fork the repository on GitHub. +2. Clone your fork locally: `git clone ` +3. Create a new branch for your feature or bug fix: `git checkout -b your-branch-name` + +## Making Changes + +1. Make your changes in your branch. +2. Follow the coding style and conventions used in the project. +3. Write clear, concise commit messages. +4. Test your changes thoroughly. Run `go test ./...` (or `task test`) and write or modify existing tests when it makes sense. + +## Submitting a Pull Request + +1. Push your changes to your fork on GitHub. +2. From your fork, open a pull request in the correct branch of the main repository. +3. Provide a clear title and description for your pull request using our PR template. +4. Link any relevant issues in the pull request description. + +## Code of Conduct + +Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms. + +## Reporting Bugs + +If you find a bug, please open an issue on GitHub. Include as much detail as possible: + +- A clear and descriptive title +- Steps to reproduce the issue +- Expected behavior +- Actual behavior +- Any error messages or screenshots + +## Suggesting Enhancements + +We welcome suggestions for enhancements! Please open an issue on GitHub with: + +- A clear and descriptive title +- A detailed description of the proposed enhancement +- Any examples or mock-ups if applicable + +## Questions? + +If you have any questions, feel free to open an issue or contact the maintainers directly. + +Thank you for contributing!