mirror of https://github.com/kivy/kivy.git
63 lines
2.9 KiB
Markdown
63 lines
2.9 KiB
Markdown
##[Contributing](http://kivy.org/docs/contribute.html)
|
|
|
|
There are many ways in which you can contribute to Kivy.
|
|
Code patches are just one thing amongst others that you can submit to help the
|
|
project. We also welcome feedback, bug reports, feature requests, documentation
|
|
improvements, advertisement & advocating, testing, graphics contributions and
|
|
many different things. Just talk to us if you want to help, and we will help you
|
|
help us.
|
|
|
|
#Feedback
|
|
--------
|
|
|
|
This is by far the easiest way to contribute something. If you're using
|
|
Kivy for your own project, don't hesitate sharing. It doesn't have to be a
|
|
high-class enterprise app, obviously. It's just incredibly motivating to
|
|
know that people use the things you develop and what it enables them to
|
|
do. If you have something that you would like to tell us, please don't
|
|
hesitate. Screenshots and videos are also very welcome!
|
|
We're also interested in the problems you had when getting started. Please
|
|
feel encouraged to report any obstacles you encountered such as missing
|
|
documentation, misleading directions or similar.
|
|
We are perfectionists, so even if it's just a typo, let us know.
|
|
|
|
#[Reporting an Issue](http://kivy.org/docs/contribute.html#reporting-an-issue)
|
|
|
|
If you found anything wrong, a crash, segfault, missing documentation, invalid
|
|
spelling, weird example, please take 2 minutes to report the issue. following
|
|
the guide lines mentioned [here](http://kivy.org/docs/contribute.html#reporting-an-issue)
|
|
|
|
##[Code Contributions](http://kivy.org/docs/contribute.html#code-contributions)
|
|
|
|
Code contributions (patches, new features) are the most obvious way to help with
|
|
the project's development. Since this is so common we ask you to follow our
|
|
workflow to most efficiently work with us. Adhering to our workflow ensures that
|
|
your contribution won't be forgotten or lost. Also, your name will always be
|
|
associated with the change you made, which basically means eternal fame in our
|
|
code history (you can opt-out if you don't want that).
|
|
|
|
|
|
* [Coding style](http://kivy.org/docs/contribute.html#coding-style)
|
|
* [Performances](http://kivy.org/docs/contribute.html#performances)
|
|
* [Git & GitHub](http://kivy.org/docs/contribute.html#git-github)
|
|
* [Code Workflow](http://kivy.org/docs/contribute.html#code-workflow)
|
|
|
|
##[Documentation Contributions](http://kivy.org/docs/contribute.html#documentation-contributions)
|
|
|
|
Documentation contributions generally follow the same workflow as code
|
|
contributions, just a bit more lax. We don't ask you to go through all the
|
|
hassle just to correct a single typo. For more complex contributions, please
|
|
consider following the suggested workflow though.
|
|
|
|
|
|
* #[Docstrings](http://kivy.org/docs/contribute.html#docstrings)
|
|
|
|
|
|
#Unit tests contributions
|
|
|
|
For testing team, we have the document `contribute-unittest` that
|
|
explains how Kivy unit test are working and how you can create your own. Use the
|
|
same approach as the `Code Workflow` to [submit new tests](http://kivy.org/docs/contribute.html#unit-tests-contributions).
|
|
|
|
|