-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 36eade9
Showing
3 changed files
with
78 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# How to Contribute | ||
|
||
Contributions are welcome! Not familiar with the codebase yet? No problem! | ||
There are many ways to contribute to open source projects: reporting bugs, | ||
helping with the documentation, spreading the word and of course, adding | ||
new features and patches. | ||
|
||
## Getting Started | ||
|
||
- Make sure you have a GitHub account. | ||
- Open a [new issue](https://github.com/snipsco/snips-actions-runner-hook/issues), assuming one does not already exist. | ||
- Clearly describe the issue including steps to reproduce when it is a bug. | ||
|
||
## Making Changes | ||
|
||
- Fork this repository. | ||
- Create a feature branch from where you want to base your work. | ||
- Make commits of logical units (if needed rebase your feature branch before | ||
submitting it). | ||
- Check for unnecessary whitespace with `git diff --check` before committing. | ||
- Make sure your commit messages are well formatted. | ||
- If your commit fixes an open issue, reference it in the commit message (f.e. `#15`). | ||
- Run all the tests (if existing) to assure nothing else was accidentally broken. | ||
|
||
These guidelines also apply when helping with documentation. | ||
|
||
## Submitting Changes | ||
|
||
- Push your changes to a feature branch in your fork of the repository. | ||
- Submit a `Pull Request`. | ||
- Wait for maintainer feedback. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License | ||
|
||
Copyright (c) 2019 Snips | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# snips-actions-runner-hook | ||
|
||
[](https://github.com/snipsco/snips-actions-runner-hook/blob/master/LICENSE) | ||
|
||
This hook allows `snips-skill-server` execute `snips-actions-runner` for running Snips actions which are wroten in Node.JS. | ||
|
||
### Installation | ||
|
||
``` | ||
git clone https://github.com/snipsco/snips-actions-runner-hook.git | ||
cd snips-actions-runner-hook | ||
./setup.sh | ||
``` | ||
|
||
## Tips | ||
|
||
1/ This hook can be installed as a normal snips action code | ||
2/ All the Node.JS actions need to be isntalled on branch `use-toolkit` | ||
|
||
## Contributing | ||
|
||
Please see the [Contribution Guidelines](https://github.com/snipsco/snips-actions-runner-hook/blob/master/CONTRIBUTING.md). | ||
|
||
## Copyright | ||
|
||
This library is provided by [Snips](https://www.snips.ai) as Open Source software. See [LICENSE](https://github.com/snipsco/snips-actions-runner-hook/blob/master/LICENSE) for more information. |