yellow/CONTRIBUTING.md

40 lines
2.1 KiB
Markdown
Raw Normal View History

2018-06-14 20:40:48 +00:00
Contributing guidelines
=======================
2020-02-05 15:21:58 +00:00
Let's make things for people. Your contribution is very welcome.
2018-07-25 11:50:51 +00:00
## How to report a problem
2018-06-14 20:40:48 +00:00
1. [Submit a new issue for each problem](https://github.com/datenstrom/yellow/issues).
2018-06-28 21:11:13 +00:00
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
## How to suggest an idea
2018-06-14 20:40:48 +00:00
1. [Submit a new issue for each idea](https://github.com/datenstrom/yellow/issues).
2020-02-03 18:10:06 +00:00
2. Explain your idea, how it would make your everyday life easier.
2020-01-30 23:12:54 +00:00
3. Vote for good ideas, give them a thumbs-up. [What's popular?](https://github.com/datenstrom/yellow/issues?q=is%3Aopen+is%3Aissue+sort%3Areactions-%2B1-desc+label%3Aidea)
2018-06-14 20:40:48 +00:00
2020-02-05 15:21:58 +00:00
## How to improve an extension
2020-02-05 17:49:23 +00:00
1. [Fork the official repository](https://github.com/datenstrom/yellow-extensions) or the repository of a developer.
2020-02-05 22:14:03 +00:00
2. Imagine what the user wants to do, focus on the bare essentials.
3. Upload your improvement to GitHub and create a pull request.
2020-02-05 15:21:58 +00:00
2019-09-06 11:55:10 +00:00
## How to make an extension
2019-02-28 12:59:47 +00:00
2020-02-02 21:56:10 +00:00
1. [Start with an example feature](https://github.com/schulle4u/yellow-extension-example), [language](https://github.com/datenstrom/yellow-extensions/blob/master/languages/english/english-language.txt) or [theme](https://github.com/schulle4u/yellow-extension-basic).
2019-09-06 11:55:10 +00:00
2. Aim for a simple solution, first make it work then make it better.
2020-02-05 15:21:58 +00:00
3. Publish your extension with the [release extension](https://github.com/datenstrom/yellow-extensions/tree/master/features/release).
## How to stay in touch
2019-02-28 12:59:47 +00:00
1. [Click on 'Watch' at the top](https://github.com/datenstrom/yellow).
2. Answer questions and discus problems with others, if you enjoy it.
2019-12-31 14:14:04 +00:00
3. Be notified of new releases in your mailbox. [What's new?](https://github.com/datenstrom/yellow/releases)
<p>
<a href="CONTRIBUTING-de.md"><img src="https://raw.githubusercontent.com/datenstrom/yellow-extensions/master/features/help/language-de.png" width="15" height="15" alt="Deutsch">&nbsp; Deutsch</a>&nbsp;
<a href="CONTRIBUTING.md"><img src="https://raw.githubusercontent.com/datenstrom/yellow-extensions/master/features/help/language-en.png" width="15" height="15" alt="English">&nbsp; English</a>&nbsp;
</p>