kivy / python-for-android / 7232729730

64%

push

github

Update Contributing Guidelines and Readme (#2922)

* Update Contributing Guidelines and Readme

### Contributing Guidelines

* Refer to Kivy for the heavy-lifting, and discuss the *differences* with Kivy.
* Made wording more consistent with other sources.
* Removed empty promise of a release every 4 weeks. That isn't a sustainable rate.
* Very mild copy-edit.

### ReadMe

* Refer to Kivy for details of support, rather than repeating.
* Refer to p4a Contributing Guidelines, rather than repeating
* Refer to Quickstart rather than repeating
* Increased space for all the current sponsors and provisioned a far way into the future.
   * Could have used an SVG here, but the comment promised we would include a link :-(

* Update for review comments

Use nicer alternatives for URLs.
Move History section from README to Contributing Guidelines.

* Make doc structure consistent and up-to-date

This is part of an effort to make the Kivy sibling projects' documentation
structure consistent and up-to-date.

CHECKLIST

* CONTRIBUTING.md
   [x] If repo takes user contributions, is present
   [x] In root dir (not .github dir)
   [x] Explains relationship to Kivy, if unclear.
   [x] Refers to kivy/kivy Contribution Guidelines.
MORE TO GO HERE

* LICENSE
   [x] If repo takes user contributions, is present.
   [x] Acknowledges the range of years to 2023.
   [x] Acknowledges Kivy Team and other contributors
   [x] Mentions it is an MIT License.

* CODE_OF_CONDUCT.md
   [x] If repo takes user contributions or hosts discussions, is present.
   [x] Refers to kivy/kivy CODE_OF_CONDUCT.md

* CONTACT.md
   [x] Refers to kivy/kivy CONTACT.md

* FAQ.md
   [x] If repo is big enough for RST documentation, is present.

* README:
   [x] Is a Markdown file.
   [x] Describes the project.
   [x] Describes its place in the Kivy sibling projects.
   [x] If Documentation exists, mention it.
   [x] If CONTRIBUTING exists, mentions it.... (continued)

941 of 2243 branches covered (0.0%)

Branch coverage included in aggregate %.

4734 of 7361 relevant lines covered (64.31%)

2.56 hits per line