yellow/CONTRIBUTING.md

23 lines
822 B
Markdown
Raw Normal View History

2018-06-14 20:40:48 +00:00
Contributing guidelines
=======================
2018-07-25 11:50:51 +00:00
## How to report a problem
2018-06-14 20:40:48 +00:00
2018-06-28 21:11:13 +00:00
1. [Submit an issue for each problem](https://github.com/datenstrom/yellow/issues).
2. Describe your problem, sometimes there are different solutions.
3. Add a lot of details, the more we know the better we can help.
2018-06-14 20:40:48 +00:00
2019-03-05 13:59:47 +00:00
## How to improve something
2018-06-14 20:40:48 +00:00
2018-06-28 21:11:13 +00:00
1. [Make sure it works in the developer kit](https://github.com/datenstrom/yellow-developers).
2018-07-25 11:50:51 +00:00
2. Chose a simple solution, imagine what the user wants to do.
2019-03-05 13:59:47 +00:00
3. Send a pull request, use the style of existing files.
2018-06-14 20:40:48 +00:00
2019-03-05 13:59:47 +00:00
## How to add something
2019-02-28 12:59:47 +00:00
1. [Start with the example extension](https://github.com/schulle4u/yellow-extension-example).
2. Create a new repository, update code and documentation.
2019-03-05 13:59:47 +00:00
3. Publish it, add a link to the existing extensions.
2019-02-28 12:59:47 +00:00
2018-07-25 11:50:51 +00:00
Your feedback and help is much appreciated. :+1: