Skip to content

Commit 3eb0843

Browse files
authored
Add contributing language (#52)
1 parent 1634bcd commit 3eb0843

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,13 @@ page = 1 # Pass in which page of preferences you'd like
215215
Patch::Preference.retrieve_preferences(page: page)
216216
```
217217

218-
## Development
218+
## Contributing
219+
220+
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!
221+
222+
On the other hand, contributions to the README, as well as new test cases are always very welcome!
223+
224+
### Testing locally
219225

220226
To build the gem locally, run:
221227

@@ -229,20 +235,16 @@ This will create a .gem file. To install the local gem:
229235
gem install patch_ruby-1.x.x.gem
230236
```
231237

232-
Install dependencies:
233-
234-
```bash
235-
bundle install
236-
```
238+
### Running tests
237239

238-
Set up required environment variables:
240+
Set up the required environment variable.
239241

240242
```bash
241243
export SANDBOX_API_KEY=<SANDBOX API KEY>
242244
```
243245

244-
Run tests:
246+
then run the tests:
245247

246248
```bash
247-
bundle exec rspec
249+
make test
248250
```

0 commit comments

Comments
 (0)