From 2baa909c73886d2e229ea98e4e0091c7907929c8 Mon Sep 17 00:00:00 2001 From: Jesse Rosalia Date: Fri, 10 Jan 2025 14:03:27 -0800 Subject: [PATCH 1/9] added CONTRIBUTING.md file --- CONTRIBUTING.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..f916716bd --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +# Contributing + +We welcome contributions and suggestions to this project. Your contributions can be code changes in a pull request or reporting bugs and feature requests. + +Once you have submitted a pull request, sign the Contributor License Agreement (CLA) by clicking on the badge in the comment from @CLAassistant. + +Please also make sure that any pull request has a corresponding issue filled out with the necessary context. [Click here to create one](/issues/new/choose). + +## Generated code + +This project has a combination of hand-written code and code generated from our private code generator. Any generated files will have a comment that says "File generated from our OpenAPI spec." Generated blocks of code within hand-written files will be between a comments that says "The beginning of the section generated from our OpenAPI spec" and "The end of the section generated from our OpenAPI spec". If your contribution involves changes to generated code, please call this out in the issue or PR as we will likely need to make a change to our code generator before accepting the contribution. + +## Set up your dev environment + +Please refer to this project's [README.md](/README.md#development) for instructions on how to set up your development environment. From 12b2ba4635dab8aeda1a0034d67c616512e2cc6b Mon Sep 17 00:00:00 2001 From: Jesse Rosalia Date: Fri, 10 Jan 2025 14:06:48 -0800 Subject: [PATCH 2/9] fixed relative links --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f916716bd..aa9067cfa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ We welcome contributions and suggestions to this project. Your contributions can Once you have submitted a pull request, sign the Contributor License Agreement (CLA) by clicking on the badge in the comment from @CLAassistant. -Please also make sure that any pull request has a corresponding issue filled out with the necessary context. [Click here to create one](/issues/new/choose). +Please also make sure that any pull request has a corresponding issue filled out with the necessary context. [Click here to create one](issues/new/choose). ## Generated code @@ -12,4 +12,4 @@ This project has a combination of hand-written code and code generated from our ## Set up your dev environment -Please refer to this project's [README.md](/README.md#development) for instructions on how to set up your development environment. +Please refer to this project's [README.md](README.md#development) for instructions on how to set up your development environment. From 7eaa7fe7415c06936c8afd6f7b1223e598f7bb08 Mon Sep 17 00:00:00 2001 From: Jesse Rosalia Date: Fri, 10 Jan 2025 14:14:12 -0800 Subject: [PATCH 3/9] fixed "create new issue" link added contribution guidelines link to README --- CONTRIBUTING.md | 2 +- README.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aa9067cfa..05323e7d1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ We welcome contributions and suggestions to this project. Your contributions can Once you have submitted a pull request, sign the Contributor License Agreement (CLA) by clicking on the badge in the comment from @CLAassistant. -Please also make sure that any pull request has a corresponding issue filled out with the necessary context. [Click here to create one](issues/new/choose). +Please also make sure that any pull request has a corresponding issue filled out with the necessary context. [Click here to create one](https://www.github.com/stripe/stripe-ruby/issues/new/choose). ## Generated code diff --git a/README.md b/README.md index d1b44944a..121329afa 100644 --- a/README.md +++ b/README.md @@ -362,6 +362,8 @@ New features and bug fixes are released on the latest major version of the Strip ## Development +[Contribution guidelines for this project](CONTRIBUTING.md) + The test suite depends on [stripe-mock], so make sure to fetch and run it from a background terminal ([stripe-mock's README][stripe-mock] also contains instructions for installing via Homebrew and other methods): From 54049905e4a90d7f1c79079a6ed04467cb5b4675 Mon Sep 17 00:00:00 2001 From: jar-stripe Date: Fri, 10 Jan 2025 14:19:18 -0800 Subject: [PATCH 4/9] Update CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 05323e7d1..dc9a3791e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,6 +10,10 @@ Please also make sure that any pull request has a corresponding issue filled out This project has a combination of hand-written code and code generated from our private code generator. Any generated files will have a comment that says "File generated from our OpenAPI spec." Generated blocks of code within hand-written files will be between a comments that says "The beginning of the section generated from our OpenAPI spec" and "The end of the section generated from our OpenAPI spec". If your contribution involves changes to generated code, please call this out in the issue or PR as we will likely need to make a change to our code generator before accepting the contribution. +## Supported platforms + +This project supports a range of platform versions. Contributions are expected to support the same platform versions. If your contribution uses a platform API that is only available in newer versions, try to identify a polyfill or legacy library that will ensure it supports older versions. We are unable to accept contributions that change the platform versions this project supports. + ## Set up your dev environment Please refer to this project's [README.md](README.md#development) for instructions on how to set up your development environment. From a13126779f680b4d0709e6d1d3f4b5a41f6ebbb8 Mon Sep 17 00:00:00 2001 From: jar-stripe Date: Fri, 10 Jan 2025 14:26:00 -0800 Subject: [PATCH 5/9] Update CONTRIBUTING.md added section on maintaining compatibility with older platforms --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dc9a3791e..b694d23f0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,11 +8,11 @@ Please also make sure that any pull request has a corresponding issue filled out ## Generated code -This project has a combination of hand-written code and code generated from our private code generator. Any generated files will have a comment that says "File generated from our OpenAPI spec." Generated blocks of code within hand-written files will be between a comments that says "The beginning of the section generated from our OpenAPI spec" and "The end of the section generated from our OpenAPI spec". If your contribution involves changes to generated code, please call this out in the issue or PR as we will likely need to make a change to our code generator before accepting the contribution. +This project has a combination of hand-written code and code generated from our private code generator. Any generated files will have a comment that says `File generated from our OpenAPI spec.` Generated blocks of code within hand-written files will be between a comments that says `The beginning of the section generated from our OpenAPI spec` and `The end of the section generated from our OpenAPI spec`. If your contribution involves changes to generated code, please call this out in the issue or pull request as we will likely need to make a change to our code generator before accepting the contribution. -## Supported platforms +## Compatibility with supported platforms -This project supports a range of platform versions. Contributions are expected to support the same platform versions. If your contribution uses a platform API that is only available in newer versions, try to identify a polyfill or legacy library that will ensure it supports older versions. We are unable to accept contributions that change the platform versions this project supports. +This project supports a wide range of platform versions, and we are unable to accept any contribution that only works on a subset of these versions. If your contribution needs to use a platform API or feature that is only available in some of the supported versions, please call this out explicitly in the issue or pull request. We will do our best to figure out how to help you out here, or plan to accept your pull request later when we can drop support for older versions. ## Set up your dev environment From 578015a41d0c5e517c1ad00796f8065a4e8dd85e Mon Sep 17 00:00:00 2001 From: jar-stripe Date: Tue, 14 Jan 2025 16:51:41 -0800 Subject: [PATCH 6/9] Update CONTRIBUTING.md clarified language about generated code Co-authored-by: Ramya Rao <100975018+ramya-stripe@users.noreply.github.com> --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b694d23f0..4c5fc01c9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,9 @@ Please also make sure that any pull request has a corresponding issue filled out ## Generated code -This project has a combination of hand-written code and code generated from our private code generator. Any generated files will have a comment that says `File generated from our OpenAPI spec.` Generated blocks of code within hand-written files will be between a comments that says `The beginning of the section generated from our OpenAPI spec` and `The end of the section generated from our OpenAPI spec`. If your contribution involves changes to generated code, please call this out in the issue or pull request as we will likely need to make a change to our code generator before accepting the contribution. +This project has a combination of manually maintained code and code generated from our private code generator. If your contribution involves changes to generated code, please call this out in the issue or pull request as we will likely need to make a change to our code generator before accepting the contribution. + +To identify files with purely generated code, look for the comment `File generated from our OpenAPI spec.` at the start of the file. Generated blocks of code within hand-written files will be between comments that say `The beginning of the section generated from our OpenAPI spec` and `The end of the section generated from our OpenAPI spec`. ## Compatibility with supported platforms From fc0a8ef4edee7762d6377f10ad79354503b29454 Mon Sep 17 00:00:00 2001 From: jar-stripe Date: Tue, 14 Jan 2025 17:14:00 -0800 Subject: [PATCH 7/9] Update CONTRIBUTING.md incorporated review feedback --- CONTRIBUTING.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4c5fc01c9..9cf57447d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,10 +1,12 @@ # Contributing -We welcome contributions and suggestions to this project. Your contributions can be code changes in a pull request or reporting bugs and feature requests. +We welcome bug reports, feature requests, and code contributions in a pull request. -Once you have submitted a pull request, sign the Contributor License Agreement (CLA) by clicking on the badge in the comment from @CLAassistant. +For most pull requests, we request that you identify or create an associated issue that has the necessary context. We use these issues to reach agreement on an approach and save the PR author from having to redo work. Fixing typos or documentation issues likely do not need an issue; for any issue that introduces substantial code changes, changes the public interface, or if you aren't sure, please find or [create an issue](https://www.github.com/stripe/stripe-ruby/issues/new/choose). -Please also make sure that any pull request has a corresponding issue filled out with the necessary context. [Click here to create one](https://www.github.com/stripe/stripe-ruby/issues/new/choose). +## Contributor License Agreement + +All contributors must sign the Contributor License Agreement (CLA) before we can accept their contribution. If you have not yet signed the agremenet, you will be given an option to do so when you open a pull request. You can then sign by clicking on the badge in the comment from @CLAassistant. ## Generated code @@ -12,9 +14,9 @@ This project has a combination of manually maintained code and code generated fr To identify files with purely generated code, look for the comment `File generated from our OpenAPI spec.` at the start of the file. Generated blocks of code within hand-written files will be between comments that say `The beginning of the section generated from our OpenAPI spec` and `The end of the section generated from our OpenAPI spec`. -## Compatibility with supported platforms +## Compatibility with supported language and runtime versions -This project supports a wide range of platform versions, and we are unable to accept any contribution that only works on a subset of these versions. If your contribution needs to use a platform API or feature that is only available in some of the supported versions, please call this out explicitly in the issue or pull request. We will do our best to figure out how to help you out here, or plan to accept your pull request later when we can drop support for older versions. +This project supports a [many different langauge and runtime versions](README.md#requirements) and we are unable to accept any contribution that does not work on _all_ supported versions. If, after discussing the approach in the associated issue, your change must use an API / feature that isn't available in all supported versions, please call this out explicitly in the issue or pull request so we can help figure out the best way forward. ## Set up your dev environment From 032dcbb46c6b888f339d95d948ac6abfbe534116 Mon Sep 17 00:00:00 2001 From: Jesse Rosalia Date: Wed, 15 Jan 2025 11:15:18 -0800 Subject: [PATCH 8/9] removed trailing whitespace --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9cf57447d..d730b4ad7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,4 @@ + # Contributing We welcome bug reports, feature requests, and code contributions in a pull request. @@ -12,7 +13,7 @@ All contributors must sign the Contributor License Agreement (CLA) before we can This project has a combination of manually maintained code and code generated from our private code generator. If your contribution involves changes to generated code, please call this out in the issue or pull request as we will likely need to make a change to our code generator before accepting the contribution. -To identify files with purely generated code, look for the comment `File generated from our OpenAPI spec.` at the start of the file. Generated blocks of code within hand-written files will be between comments that say `The beginning of the section generated from our OpenAPI spec` and `The end of the section generated from our OpenAPI spec`. +To identify files with purely generated code, look for the comment `File generated from our OpenAPI spec.` at the start of the file. Generated blocks of code within hand-written files will be between comments that say `The beginning of the section generated from our OpenAPI spec` and `The end of the section generated from our OpenAPI spec`. ## Compatibility with supported language and runtime versions @@ -21,3 +22,4 @@ This project supports a [many different langauge and runtime versions](README.md ## Set up your dev environment Please refer to this project's [README.md](README.md#development) for instructions on how to set up your development environment. + From 59831e7874bfce89612aaf494e0db6c73e5896d6 Mon Sep 17 00:00:00 2001 From: Jesse Rosalia Date: Wed, 15 Jan 2025 14:52:21 -0800 Subject: [PATCH 9/9] fixed typos --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d730b4ad7..4103cb42f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,7 @@ For most pull requests, we request that you identify or create an associated iss ## Contributor License Agreement -All contributors must sign the Contributor License Agreement (CLA) before we can accept their contribution. If you have not yet signed the agremenet, you will be given an option to do so when you open a pull request. You can then sign by clicking on the badge in the comment from @CLAassistant. +All contributors must sign the Contributor License Agreement (CLA) before we can accept their contribution. If you have not yet signed the agreement, you will be given an option to do so when you open a pull request. You can then sign by clicking on the badge in the comment from @CLAassistant. ## Generated code @@ -17,7 +17,7 @@ To identify files with purely generated code, look for the comment `File generat ## Compatibility with supported language and runtime versions -This project supports a [many different langauge and runtime versions](README.md#requirements) and we are unable to accept any contribution that does not work on _all_ supported versions. If, after discussing the approach in the associated issue, your change must use an API / feature that isn't available in all supported versions, please call this out explicitly in the issue or pull request so we can help figure out the best way forward. +This project supports [many different langauge and runtime versions](README.md#requirements) and we are unable to accept any contribution that does not work on _all_ supported versions. If, after discussing the approach in the associated issue, your change must use an API / feature that isn't available in all supported versions, please call this out explicitly in the issue or pull request so we can help figure out the best way forward. ## Set up your dev environment