This Software is designed to work as a plugin for the so called rsiServer (https://github.com/wzr1337/rsiServer).
I welcome everyone to contribute to this repo. Let us build awesome software - together. In order to streamline contribution to this repo, some guidelines are described below.
In order to maintain a maximum of software quality, tests are needed. Whenever you contribute, please make sure that appropriate tests are in place. Also contributing tests only is highly valuable for the project.
These rules are adopted from the AngularJS commit conventions.
Each commit message starts with a type, a scope, and a subject.
Below that, the commit message has a body.
- type: what type of change this commit contains.
- scope: what item of code this commit is changing.
- subject: a short description of the changes.
- body (optional): a more in-depth description of the changes
<type>(<scope>): <subject>
<BLANK LINE>
<body>
Examples:
feat(ruler): add inches as well as centimeters
fix(protractor): fix 90 degrees counting as 91 degrees
refactor(pencil): use graphite instead of lead
Closes #640.
Graphite is a much more available resource than lead, so we use it to lower the price.
fix(pen): use blue ink instead of red ink
BREAKING CHANGE: Pen now uses blue ink instead of red.
To migrate, change your code from the following:
`pen.draw('blue')`
To:
`pen.draw('red')`
Any line of the commit message should not be longer 100 characters. This allows the message to be easier to read on github as well as in various git tools.
Is recommended to be one of the below items. Only feat and fix show up in the changelog, in addition to breaking changes (see breaking changes section at bottom).
- feat: A new feature
- fix: A bug fix
- docs: Documentation only changes
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- refactor: A code change that neither fixes a bug or adds a feature
- test: Adding missing tests
- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
The scope could be anything specifying place of the commit change. Usually, the affected resource is named here.
The subject contains succinct description of the change:
- use the imperative, present tense: "change" not "changed" nor "changes"
- don't capitalize first letter
- no dot (.) at the end
Put any breaking changes with migration instructions in the commit body.
If there is a breaking change, put BREAKING CHANGE: in your commit body, and it will show up in the changelog.
Copyright (c) 2018 Dr. Patrick Bartsch
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.