-
Notifications
You must be signed in to change notification settings - Fork 1.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update Contributing Guidelines and Readme #2922
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left a few easy fix comments, but overall looks good to me
Thanks for the review, @AndreMiras. Corrections now submitted. |
Some comments on the Kivy/kivy equivalent to this PR may impact this one. Please don't merge for a few days while it is resolved. |
In the meantime, there has been a lot of work done in making the documents consistent across Kivy Framework, Buildozer, PyJnius, Plyer, etc. I have been using a checklist (which continues to evolve as more projects add more challenges.). This brings python-for-android into line with the others. |
This is part of an effort to make the Kivy sibling projects' documentation CHECKLIST
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see a lot of unrelated commits have been added to this branch.
Can you please rebase instead?
### 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 :-(
Use nicer alternatives for URLs. Move History section from README to Contributing Guidelines.
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. [x] If LICENSE exists, mentions it. [x] If CODE_OF_CONDUCT exists, mentions it. [x] Mentions kivy/kivy CONTACT.md [NA] Uses Python syntax colouring for embedded Python code. [x] Uses badges to display current status, including: [x] Backers [x] Sponsors [x] GitHub contributors [x] Contributor Covenant [x] PyPI Version [x] PyPI Python Version [x] Build/Test status [x] Displays all contributors to the repo. [x] Displays backers [x] Displays top sponsors. * RST documentation, if present [x] Describes the project. [x] Describes its place in the Kivy sibling projects. [x] Mentions (Kivy/Kivy) Contact Us link. [x] Mentions LICENSE. [x] Mentions CONTRIBUTING [x] Mentions FAQ [x] conf.py mentioned Kivy Team and other contributors - copyright, latex_documents, man_pages, texinfo documents * WORKFLOWS [x] NO_RESPONSE.yml is present if the repo has awaiting_reply tag. [x] NO_RESPONSE uses latest script versions. [x] NO_RESPONSE runs every day, and skips if forked. [x] SUPPORT.yml is present if the repo has a `support` tag. [x] SUPPORT.yml refers to repo's CONTACT.md * setup.py/cfg, if present and on PyPI [x] Supplies description to PyPI [x] Supplies Python versions to PyPI [x] Supplies Documentation, if any, to PyPI
6c82e42
to
c04727c
Compare
I have some elaborate theories about why Git personally hates me so much. Fixed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @Julian-O ,
Is all almost fine, except for the APK/AAB/AAR part.
I've left a comment on README.md, but a similar issue is present on doc/source/index.rst
.
Feel free to ping me on Discord if you need some further explanation.
doc/source/index.rst
Outdated
It can generate Android Package (APK) files, which can be installed on Android | ||
with everything it needs to run. It can generate both debug and signed release | ||
APKs - the latter can be shared on marketplaces, like | ||
`Google Play Store <https://play.google.com/store/>`_. | ||
|
||
It can also generate | ||
`Android App Bundle <https://developer.android.com/guide/app-bundle/faq>`_ (AAB) | ||
files that can be bundled with others into an APK. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The same changes suggested in README.md
should also be applied here.
Also cleared merge artifact. This was a response to review comments.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thank you!
Contributing Guidelines
ReadMe