Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (47 loc) · 3.68 KB

CONTRIBUTING.md

File metadata and controls

76 lines (47 loc) · 3.68 KB
Raw

Contributing to the Elastic Email Ruby SDK

Thanks for taking the time to contribute! This document explains how to report problems, suggest changes and submit pull requests.

Before you start: this SDK is generated

Almost everything in this repository (lib/ElasticEmail/api, lib/ElasticEmail/models, the client files in lib/ElasticEmail, spec/, docs/ and most of README.md) is generated by OpenAPI Generator from the Elastic Email API specification.

This means:

  • Manual edits to generated files will be overwritten by the next release.
  • If an endpoint, model, parameter or description is wrong or missing, the fix belongs in the API specification. Please open an issue describing the problem. We'll fix it upstream and regenerate the SDK.
  • Pull requests are most useful for non-generated content: documentation, examples, tests, build and CI configuration, and repository tooling.

If you're not sure whether something is generated, open an issue first and ask.

Reporting bugs

Search existing issues first. If nothing matches, open a new issue using the Bug report template and include:

  • SDK version (from RubyGems, e.g. 4.2.0; run gem list ElasticEmail)
  • Ruby version (ruby -v)
  • The API method you called and a minimal code sample
  • The full error message, HTTP status code and response body (ElasticEmail::ApiError#code and #response_body)

Never paste your API key into an issue, log or code sample.

Questions about your Elastic Email account, sending limits, deliverability or billing aren't handled in this repository. The preferred way to get help is the chat widget on elasticemail.com.

Looking for sample code? See the Elastic Email examples repository, including the Ruby examples.

Suggesting features

Open an issue using the Feature request template. Describe the use case first and the solution second. It helps us decide whether the change belongs in the API, the SDK or the documentation.

Security issues

Please do not report security vulnerabilities in public issues. See SECURITY.md.

Development setup

Requirements: Ruby 2.7 or later and Bundler.

git clone https://github.com/ElasticEmail/elasticemail-ruby.git
cd elasticemail-ruby
bundle install
bundle exec rspec

To build and install the gem locally:

gem build ElasticEmail.gemspec
gem install ./ElasticEmail-4.2.0.gem

Keep the gem compatible with Ruby 2.7 and don't add new runtime dependencies without discussing it in an issue first.

Pull requests

  1. Fork the repository and create a branch from master (git checkout -b fix/short-description).
  2. Keep each change focused. One logical change per pull request.
  3. Make sure bundle exec rspec and gem build ElasticEmail.gemspec pass.
  4. Update documentation if your change affects how the SDK is used.
  5. Open a pull request against master and fill in the template.

A maintainer will review your pull request and may ask for changes. When a change touches generated code, we may apply it upstream instead of merging the PR directly. You'll still get credit in the release notes.

Code of Conduct

This project follows the Contributor Covenant Code of Conduct. By participating, you agree to uphold it.

License

By contributing, you agree that your contributions will be licensed under the MIT License.