Skip to content

Commit

Permalink
Add keywords, extend tslint repo, add contributing section to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ChiriVulpes committed Aug 1, 2017
1 parent 57531bb commit cbe3833
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 2 deletions.
38 changes: 38 additions & 0 deletions README.md
Expand Up @@ -162,6 +162,44 @@ Adds a listener for when the emitter errors. This method returns the emitter obj
Cancels emitting data. Only emits the "cancel" event, not the "end" event.


## Contributing

Thanks for wanting to help out! Here's the setup you'll have to do:
```bat
git clone https://github.com/Yuudaari/mtg-sdk-typescript
git clone https://github.com/Yuudaari/tslint.json
cd mtg-sdk-typescript
npm install
```
You can now make changes to the repository.

To compile:
```bat
gulp ts
```
To test:
```bat
gulp mocha
```
To compile, then test:
```bat
gulp compile-test
```
To compile and then test on every file change:
```bat
gulp watch
```

If you want to make large, complex changes, make an issue before creating a PR. If I disagree with the changes you want to make, and you've already made them all in a PR, it'll feel a lot worse than being shot down in an issue, before you've written it all.

Pull Requests may be rejected if outside of the scope of the SDK, or not following the formatting rules. If tslint complains, I will complain. Please don't be mad.

If you add a new feature, please include a test for it in your PR.

Thanks again!



## MIT License

[Copyright 2017 Mackenzie McClane](./LICENSE)
2 changes: 1 addition & 1 deletion package.json
Expand Up @@ -10,7 +10,7 @@

"description": "An sdk for https://magicthegathering.io/ written in Typescript. Works for JavaScript and TypeScript development.",
"keywords": [

"magic", "magic-the-gathering", "gathering", "api", "mtgsdk", "typescript", "card", "cards"
],
"license": "MIT",
"repository": {
Expand Down
2 changes: 1 addition & 1 deletion tslint.json
@@ -1,5 +1,5 @@
{
"extends": [
"C:/Users/Mackenzie/Github/other/config/tslint.json"
"../tslint.json/tslint.json"
]
}

0 comments on commit cbe3833

Please sign in to comment.