Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added CONTRIBUTING.md file #1515

Merged
merged 9 commits into from
Jan 15, 2025
Merged

Added CONTRIBUTING.md file #1515

merged 9 commits into from
Jan 15, 2025

Conversation

jar-stripe
Copy link
Contributor

@jar-stripe jar-stripe commented Jan 10, 2025

Why?

Introduce guidelines and tips on how to contribute in order to better enable our development community to make contributions to the SDK.

What?

  • add CONTRIBUTING.md and update README.md with a link

added contribution guidelines link to README
added section on maintaining compatibility with older platforms
@jar-stripe jar-stripe marked this pull request as ready for review January 10, 2025 22:40
@jar-stripe jar-stripe requested review from helenye-stripe, xavdid-stripe and ramya-stripe and removed request for helenye-stripe January 10, 2025 22:41
Copy link
Member

@xavdid-stripe xavdid-stripe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! some little brevity comments you can take or leave, but I like it.

Also, since nothing in this file is especially ruby-specific, we could have a single copy of it in codegen and copy it over as part of generation. Might need to do some light find-and-replace for the language name to link to issues correctly, but I don't think that's too bad. It'll save us from having to update any typos/changes manually 7 times!

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@jar-stripe
Copy link
Contributor Author

Also, since nothing in this file is especially ruby-specific, we could have a single copy of it in codegen and copy it over as part of generation. Might need to do some light find-and-replace for the language name to link to issues correctly, but I don't think that's too bad. It'll save us from having to update any typos/changes manually 7 times!

I love this idea. I was actually thinking of how to do this, and maintaining a template in codegen that gets copied over as part of generation makes a lot of sense!

jar-stripe and others added 4 commits January 14, 2025 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants