From b745c3ab035ef0e9dcb9790f924c6318cb6aaff7 Mon Sep 17 00:00:00 2001 From: jar-stripe Date: Thu, 16 Jan 2025 10:01:08 -0800 Subject: [PATCH 1/3] pinned ubuntu version and added TODO (#3047) --- .github/workflows/ci.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 8918de61b..4e92eca6c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -21,7 +21,8 @@ jobs: build: name: Build and test - runs-on: ubuntu-latest + # TODO: this step is not compatible with ubuntu 24 LTS, so we pin the version here instead of using ubuntu-latest + runs-on: ubuntu-22.04 steps: - uses: extractions/setup-just@v2 From a9c875fbfe6df7a2146f670ac409e013a9d65cba Mon Sep 17 00:00:00 2001 From: jar-stripe Date: Thu, 16 Jan 2025 10:11:36 -0800 Subject: [PATCH 2/3] Added CONTRIBUTING.md file (#3045) --- CONTRIBUTING.md | 25 +++++++++++++++++++++++++ README.md | 2 ++ 2 files changed, 27 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..a981948cb --- /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-dotnet/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 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 + +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 [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. + diff --git a/README.md b/README.md index 31eb1aaf2..cdfc5f8b5 100644 --- a/README.md +++ b/README.md @@ -308,6 +308,8 @@ New features and bug fixes are released on the latest major version of the Strip ## Development +[Contribution guidelines for this project](CONTRIBUTING.md) + .NET 8 is required to build and test Stripe.net SDK, you can install it from [get.dot.net](https://get.dot.net/). The test suite depends on [stripe-mock][stripe-mock], so make sure to fetch From b263a39180e67868e4fb5d92f0c7c6e921b68428 Mon Sep 17 00:00:00 2001 From: David Brownman <109395161+xavdid-stripe@users.noreply.github.com> Date: Thu, 16 Jan 2025 11:34:16 -0800 Subject: [PATCH 3/3] update justfile import (#3046) --- justfile | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/justfile b/justfile index 87c26cf39..50a0dcbfe 100644 --- a/justfile +++ b/justfile @@ -1,6 +1,6 @@ set quiet -import? '../sdk-codegen/justfile' +import? '../sdk-codegen/utils.just' _default: just --list --unsorted @@ -22,10 +22,6 @@ format *args: # This sets TargetFramework because of a race condition in dotnet format when it tries to format to multiple targets at a time, which could lead to code with compiler errors after it completes TargetFramework=net5.0 dotnet format src/Stripe.net/Stripe.net.csproj --severity warn {{args}} -# for backwards compatibility; ideally removed later -[private] -alias codegen-format := format - # verify, but don't modify, the project's formatting format-check: (format "--verify-no-changes")