Contributing to ArrayMixer
September 29, 2017 ยท View on GitHub
Contributing to ArrayMixer
So nice you wanna contribute to this repository. Thank you. You may contribute in several ways like:
- Creating new features
- Fixing bugs
- Improving documentation and examples
- Translating any document here to your language
Table of contents
Developing ArrayMixer
There is only one main source file in the project. It is the /src/array-mixer.js. The /src/spec.js is for now the only unit test file in the project.
The release folder includes the transpiled ES5 version of the source code, this folder is only avaliable in the []npm package](https://www.npmjs.com/package/array-mixer).
Running tests
Run unit tests using this command:
npm test
Reporting a bug
Use the GitHub issue tracker to report any bug you find. Bugs description should include:
- How to reproduce the bug;
- Easy to understand title;
Would be nice to have some code showing how to reproduce the code, you may use gist or Codepen for uploading your example code.
Request a feature
Use the GitHub issue tracker to request a new feature.
Keep in mind ArrayMixer intends to be a pure javascript library
Feel free to port it to your favorite framework, such as Angular or VueJs in a new repository.
Commit message
Commit messages should includes GitHub number reference and a imperative easy to understand sentence.
Code style
Feel free to use ES2015 and ES2017 features. Be sure to correctly transpile the source code to ES5.
ArrayMixer has its own ESLint specifications and they need to be followed.
Thank you for reading this.
Give this repo a star and/or share it with your friends.