From f4fff980a75a0ebb7ed7e794337774e7cc0463d9 Mon Sep 17 00:00:00 2001 From: Jesse Rosalia Date: Wed, 15 Jan 2025 11:28:18 -0800 Subject: [PATCH 1/3] Added CONTRIBUTING.md file --- CONTRIBUTING.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..de901c0319 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ + +# Contributing + +We welcome bug reports, feature requests, and code contributions in a pull request. + +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-node/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 + +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 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. + +## 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 67e47a126b22e67b372d69631e82dfacba6ca7ac Mon Sep 17 00:00:00 2001 From: jar-stripe Date: Wed, 15 Jan 2025 11:55:07 -0800 Subject: [PATCH 2/3] Update README.md added link to CONTRIBUTING.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 174c0d38e6..4412f4dbbc 100644 --- a/README.md +++ b/README.md @@ -596,6 +596,8 @@ New features and bug fixes are released on the latest major version of the `stri ## Development +[Contribution guidelines for this project](CONTRIBUTING.md) + Run all tests: ```bash From 412918b7122d9d0a05334c64e7e3a40cc3dec18f Mon Sep 17 00:00:00 2001 From: Jesse Rosalia Date: Wed, 15 Jan 2025 14:52:21 -0800 Subject: [PATCH 3/3] fixed typos --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index de901c0319..5c880f4289 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