Skip to content

Add contributing language #52

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Nov 10, 2021
Merged

Add contributing language #52

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
19e8eee
Add contributing language
pcothenet Nov 10, 2021
2d262bf
Merge branch 'main' into pc/contributing
pcothenet Nov 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,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:

Expand All @@ -229,20 +235,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=<SANDBOX API KEY>
```

Run tests:
then run the tests:

```bash
bundle exec rspec
make test
```