Skip to content
This repository has been archived by the owner on Jul 15, 2024. It is now read-only.

Latest commit

 

History

History
94 lines (62 loc) · 3.73 KB

CONTRIBUTING.md

File metadata and controls

94 lines (62 loc) · 3.73 KB

Hello! Thank you for choosing to help contribute to one of the Twilio SendGrid open source projects. There are many ways you can contribute, and help is always welcome.

Contributing to Beta OpenAPI v3.1 files

This project is not accepting Pull Requests against all files.

The Beta OpenAPI v3.1 specification is generated internally by Twilio SendGrid tooling. For this reason, we cannot accept Pull Requests against any of these future-facing files: oas_v3.json, all files in the /spec directory.

We do, however, welcome any Issues you report, and we will gladly add them to our internal backlog.

Note: DO NOT include your credentials in ANY code examples, descriptions, or media you make public.

Contributing to non-Beta OpenAPI v3.1 sections of the repository

Feature Request

If you'd like to make a feature request, please read this section.

The GitHub issue tracker is the preferred channel for library feature requests, but please respect the following restrictions:

  • Please search for existing issues to ensure we don't have duplicate bugs/feature requests.
  • Please be respectful and considerate of others when commenting on issues.

Submit a Bug Report

Note: DO NOT include your credentials in ANY code examples, descriptions, or media you make public.

A software bug is a demonstrable issue in the code base. For us to diagnose the issue and respond as quickly as possible, please add as much detail as possible into your bug report.

Before you decide to create a new issue, please try the following:

  1. Check the Github issues tab if the identified issue has already been reported, if so, please add a +1 to the existing post.
  2. Update to the latest version of this code and check if the issue has already been fixed.
  3. Copy and fill in the Bug Report Template we have provided below.

Please use our Bug Report Template

In order to make the process easier, we've included a sample bug report template.

Creating a Pull Request

  1. Fork the project, clone your fork, and configure the remotes:

    # Clone your fork of the repo into the current directory
git clone https://github.com/sendgrid/sendgrid-oai
# Navigate to the newly cloned directory
cd sendgrid-oai
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/sendgrid/sendgrid-oai

  2. If you cloned a while ago, get the latest changes from upstream:

    git checkout <dev-branch>
git pull upstream <dev-branch>

  3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:

    git checkout -b <topic-branch-name>

  4. Commit your changes in logical chunks. Please adhere to these git commit message guidelines or your code is unlikely be merged into the main project. Use Git's interactive rebase feature to tidy up your commits before making them public.

4a. Create tests.

4b. Create or update the example code that demonstrates the functionality of this change to the code.

  1. Locally merge (or rebase) the upstream development branch into your topic branch:

    git pull [--rebase] upstream main

  2. Push your topic branch up to your fork:

    git push origin <topic-branch-name>