From 19e8eee29413b9ccffecc10ff3348989baa325bc Mon Sep 17 00:00:00 2001 From: Paul Cothenet Date: Wed, 10 Nov 2021 14:16:58 -0800 Subject: [PATCH] Add contributing language --- README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 119b488..2733a1f 100644 --- a/README.md +++ b/README.md @@ -218,7 +218,13 @@ page = 1 # Pass in which page of preferences you'd like Patch::Preference.retrieve_preferences(page: page) ``` -## Development +## Contributing + +While we value open-source contributions to this SDK, the core of this library is generated programmatically. Complex additions made directly to the library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us! + +On the other hand, contributions to the README, as well as new test cases are always very welcome! + +### Testing locally To build the gem locally, run: @@ -232,20 +238,16 @@ This will create a .gem file. To install the local gem: gem install patch_ruby-1.x.x.gem ``` -Install dependencies: - -```bash -bundle install -``` +### Running tests -Set up required environment variables: +Set up the required environment variable. ```bash export SANDBOX_API_KEY= ``` -Run tests: +then run the tests: ```bash -bundle exec rspec +make test ```