-
Notifications
You must be signed in to change notification settings - Fork 5
How to Contribute
In order to keep this Wiki organized and as clutter-free as possible, please follow these guidelines for contributing new examples or documentation to the wiki.
The Wiki is intended to be programming language agnostic as much as possible, but tutorials for how to do things may show examples in one programming language or another. Here are the sorts of things that should be put in the Wiki:
- Pure RiveScript examples ("RiveScript Snippets").
- Tutorials for how to do things in your RiveScript bot. These can use source codes of particular languages as examples, but are intended to be instructional to teach the reader how to implement a concept rather than full runnable example scripts.
- Design tips, such as how to structure a RiveScript bot.
If your example is a full runnable program, for example if you wrote a Slack bot in Python, your code should be contributed as an example to the rivescript-python repo instead.
If you're contributing a new RiveScript snippet or documentation, create a new page for it where it makes sense. The content of each page in the Wiki should be relatively self-contained and focused on its particular topic.
Edit the Wiki home page and insert a link to your new page where it makes sense. If you're contributing a RiveScript Snippet (an example or tutorial of how you can use the RiveScript language to do something cool), add a link under the appropriate header on the home page.
If there isn't an appropriate header on the home page, feel free to make your own.
To link to your Wiki page, just write the page name in double brackets, like [[How to Contribute]], and verify that the link looks good (doesn't show up in red text) on the Preview tab before saving.
Always use GitHub Flavored Markdown for your Wiki pages.