Mirrors/Tone.js
2
0
Fork 0
mirror of https://github.com/Tonejs/Tone.js synced 2024-12-26 11:33:09 +00:00
Code Issues Projects Releases Packages Wiki Activity

adding a .github folder

Browse source 
[skip ci]
This commit is contained in:
Yotam Mann 2017-03-12 22:44:41 -04:00
parent 00f6933f30
commit 4f9143c76e
3 changed files with 41 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
.github/CONTRIBUTING.md vendored Normal file
View file

@ -0,0 +1,33 @@
Bug fixes and contributions are welcome!
If you're looking for ideas for where to get started, consider jumping in on any of these areas:
### Examples
To contribute examples, please follow the current style of the examples. Add your example's title and file name to `ExampleList.js` file for it to appear in the examples list on index page.
### Docs
There is always more work that can be done on documentation. Especially adding good examples to methods and members to make the docs more informative and useful for people coming from diverse musical and technical backgrounds.
All of the docs are written in [jsdoc](http://usejsdoc.org/)-style comments in the source code. If you catch a mistake, please send a pull request.
Along with this, I'd be great to integrate more visuals and references in the docs to help illustrate concepts.
### Forum
If you are someone who is familiar with Tone.js, consider jumping in on [the forum](https://groups.google.com/forum/#!forum/tonejs) to answer some questions.
### Tutorials
I'd love to see more tutorials for newcomers to Tone.js to help them get up and running or solve a particular issue. If you make a tutorial, please send me a link.
### Tests
Tone.js has an extensive [test suite](Testing) using Mocha and Chai. I'd love help getting more of these tests to pass on Safari and Firefox.
Along with more unit tests, I'd also be great to have more tests which run in the online context and generate music to help find bugs by ear that the automated tests might not illuminate. [Audiokit](http://audiokit.io/tests/), for example, has a great suite of aural tests.
### Synths/Effects
If you'd like to contribute a cool and expressive synth or effect, i'd love to hear it. Please send me an example that i can play with along with the PR.

3
.github/ISSUE_TEMPLATE.md vendored Normal file
View file

@ -0,0 +1,3 @@
Bugs and feature requests only please. For help questions, check out [the forum](https://groups.google.com/forum/#!forum/tonejs).
If possible, please include a link which illustrates the issue.

5
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View file

@ -0,0 +1,5 @@
1. Please make all pull requests on the `dev` branch.
2. Don't commit build files
2. Try to get all [tests](https://github.com/Tonejs/Tone.js/wiki/Testing) to pass.