Skip to content

Commit d24a1f8

Browse files
authored
Add contribution guides. (#2605)
1 parent e84daf8 commit d24a1f8

33 files changed

+180
-910
lines changed

changes/2605.doc.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
New contribution guide series now available in the Briefcase documentation.

docs/config.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ validation:
1414
extra:
1515
project_name: briefcase
1616
package_name: briefcase
17+
formal_name: Briefcase
18+
min_python_version: "3.10" # The oldest supported Python version
19+
min_python_version_tag: "310" # The tag version of the minimum python version
20+
recent_python_version: "3.13" # The newest Python version known to work on all platforms
21+
docs_python_version: "3.13" # The version of Python required to build the documentation
1722
social:
1823
- icon: fontawesome/brands/github
1924
link: https://github.com/beeware
@@ -71,6 +76,7 @@ markdown_extensions:
7176
pymdownx.superfences: {}
7277
pymdownx.blocks.admonition: {}
7378
pymdownx.blocks.caption: {}
79+
pymdownx.details: {}
7480
pymdownx.blocks.tab:
7581
alternate_style: true
7682
pymdownx.snippets:

docs/en/SUMMARY.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,34 @@
2020
- Publishing your app
2121
- ./how-to/publishing/*
2222
- [Contributing to Briefcase](how-to/contribute/index.md)
23-
- [Contributing code to Briefcase](how-to/contribute/code.md)
24-
- [Contributing to the documentation](how-to/contribute/docs.md)
23+
- [First-time contributors](how-to/contribute/first_time_contributors.md)
24+
- What can I do?
25+
- [Fix an issue](how-to/contribute/what/fix_issue.md)
26+
- [Implement a new feature](how-to/contribute/what/implement_feature.md)
27+
- [Write documentation](how-to/contribute/what/write_docs.md)
28+
- [Triage an issue](how-to/contribute/what/triage.md)
29+
- [Review a pull request](how-to/contribute/what/review_pr.md)
30+
- [Propose a new feature](how-to/contribute/what/propose_feature.md)
31+
- [Use the tools](how-to/contribute/what/use_tools.md)
32+
- How do I contribute?
33+
- [Setting up a development environment](how-to/contribute/how/dev_environment.md)
34+
- [Reproducing an issue](how-to/contribute/how/reproduce_issue.md)
35+
- [Working from a branch](how-to/contribute/how/branches.md)
36+
- [Avoiding scope creep](how-to/contribute/how/scope_creep.md)
37+
- [Writing, running, and testing code](how-to/contribute/how/write_code.md)
38+
- [Building documentation](how-to/contribute/how/build_docs.md)
39+
- [Writing documentation](how-to/contribute/how/write_docs.md)
40+
- [Adding a change note](how-to/contribute/how/change_note.md)
41+
- [Submitting a pull request](how-to/contribute/how/submit_pr.md)
42+
- [Providing a review](how-to/contribute/how/review_pr.md)
43+
- [Submitting a new issue](how-to/contribute/how/new_issue.md)
44+
- [Proposing a new feature](how-to/contribute/how/propose_feature.md)
45+
- What happens next?
46+
- [Pull request review process](how-to/contribute/next/pr_review.md)
47+
- [Release process](how-to/contribute/next/release.md)
48+
- Style guides
49+
- [Code style guide](how-to/contribute/style/code_style_guide.md)
50+
- [Documentation style guide](how-to/contribute/style/docs_style_guide.md)
2551
- Internal How-to guides
2652
- [How to cut a Briefcase release](how-to/internal/release.md)
2753
- Upgrading from previous versions

docs/en/how-to/building/external-apps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ In the process of packaging an external app, Briefcase will generate an applicat
3434

3535
The files generated by the template should *not* be modified by hand. If you need to customize the contents of these templated files, you should use Briefcase app configuration settings to define those changes. For example, on macOS if you need to add an entitlement for signing purposes, you should *not* modify the templated `Entitlements.plist` file by hand - you should use the [`entitlement`][] setting in your `pyproject.toml`.
3636

37-
If Briefcase's configuration options are not sufficient for your requirements, you can either fork the template used by Briefcase and use the [`template`][] option to point at your custom template; or you can [submit a pull request to Briefcase][contribute] to support your customization use case.
37+
If Briefcase's configuration options are not sufficient for your requirements, you can either fork the template used by Briefcase and use the [`template`][] option to point at your custom template; or you can [submit a pull request to Briefcase](../contribute/how/submit_pr.md) to support your customization use case.
3838

3939
## Packaging an external app
4040

0 commit comments

Comments
 (0)