Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
38 lines (25 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

38 lines (25 loc) · 1.92 KB

Contributing to this project

Transparency is one of our core values, and we encourage developers to contribute and become part of the SparkPost developer community.

The following is a set of guidelines for contributing, which is hosted in the SparkPost Organization on GitHub. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

Submitting Issues

  • Before logging an issue, please search existing issues first.

  • You can create an issue here. Please include the version number, as per the changeLog and as much detail as possible in your report.

Local Development and Testing

  1. Fork this repo
  2. Clone your fork
  3. Import the JSON file into Postman, choosing to "replace" any existing collection of the same name
  4. Make and test your changes
  5. When you are ready, export your changes from Postman back to the repo JSON file, selecting file version 2.1
  6. Compare the differences using a file-compare utility, to ensure no unexpected changes and no private API key info present
  7. Please follow the pull request submission steps in the next section

Contribution Steps

To contribute to sparkpost-api-postman-collection:

  1. Create a new branch named after the issue you’ll be fixing, and include the issue number as the branch name, example: Issue in GH is #8 then the branch name should be ISSUE-8
  2. Submit a new Pull Request applying your feature/fix branch to the master branch

Releasing

To publish a new release:

  1. Update the ChangeLog
  2. Internal SparkPost team releases and publishes, ensuring SparkPost documentation refers to URL of updated version