Skip to content
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

Normalize contribution docs with Toga #1696

Open
freakboy3742 opened this issue Mar 14, 2024 · 0 comments
Open

Normalize contribution docs with Toga #1696

freakboy3742 opened this issue Mar 14, 2024 · 0 comments
Labels
documentation An improvement required in the project's documentation. enhancement New features, or improvements to existing features. good first issue Is this your first time contributing? This could be a good place to start!

Comments

@freakboy3742
Copy link
Member

freakboy3742 commented Mar 14, 2024

What is the problem or limitation you are having?

Briefcase has a contribution guide for docs and code; so does Toga. However, there are some elements of the Toga docs that would be useful to include in the Briefcase docs.

Describe the solution you'd like

Replicate the sections of the Toga contribution guides that aren't Toga-specific in the Briefcase docs. For example, we don't need the discussion about core and backends; but we do need the section about not submitting from your main branch, and waiting for feedback.

Describe alternatives you've considered

Consolidate these docs upstream (on the beeware.org website) so that the content isn't duplicated unnecessarily. However, developing a good narrative flow with an external site like that may be complex.

Additional context

See also beeware/toga#2453, beeware/rubicon-objc#427

@freakboy3742 freakboy3742 added enhancement New features, or improvements to existing features. documentation An improvement required in the project's documentation. good first issue Is this your first time contributing? This could be a good place to start! labels Mar 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation An improvement required in the project's documentation. enhancement New features, or improvements to existing features. good first issue Is this your first time contributing? This could be a good place to start!
Projects
None yet
Development

No branches or pull requests

1 participant