Skip to content

Commit 35efddc

Browse files
HalfWhittkattni
andauthored
Convert underscores to hyphens in contribution guide URLs (#2617)
Co-authored-by: Kattni <kattni@kattni.com>
1 parent b472f3b commit 35efddc

38 files changed

+83
-82
lines changed

changes/2617.misc.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Underscores have been converted to hyphens in the contribution guide's URLs.

docs/en/SUMMARY.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -20,34 +20,34 @@
2020
- Publishing your app
2121
- ./how-to/publishing/*
2222
- [Contributing to Briefcase](how-to/contribute/index.md)
23-
- [First-time contributors](how-to/contribute/first_time_contributors.md)
23+
- [First-time contributors](how-to/contribute/first-time-contributors.md)
2424
- 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)
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)
2828
- [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)
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)
3232
- 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)
33+
- [Setting up a development environment](how-to/contribute/how/dev-environment.md)
34+
- [Reproducing an issue](how-to/contribute/how/reproduce-issue.md)
3535
- [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)
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)
4545
- What happens next?
46-
- [Pull request review process](how-to/contribute/next/pr_review.md)
46+
- [Pull request review process](how-to/contribute/next/pr-review.md)
4747
- [Release process](how-to/contribute/next/release.md)
4848
- 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)
49+
- [Code style guide](how-to/contribute/style/code-style-guide.md)
50+
- [Documentation style guide](how-to/contribute/style/docs-style-guide.md)
5151
- Internal How-to guides
5252
- [How to cut a Briefcase release](how-to/internal/release.md)
5353
- 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/how/submit_pr.md) 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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# First-time contributors
2+
3+
{% extends "contribute/first-time-contributors.md" %}

docs/en/how-to/contribute/first_time_contributors.md

Lines changed: 0 additions & 3 deletions
This file was deleted.
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# Building documentation
22

3-
{% extends "contribute/how/build_docs.md" %}
3+
{% extends "contribute/how/build-docs.md" %}
44

55
{% block front_matter %}
66

7-
Before you build the documentation, and have a [development environment](dev_environment.md) set up.
7+
Before you build the documentation, and have a [development environment](dev-environment.md) set up.
88

99
{% endblock %}
1010

1111
{% block end_matter %}
1212

13-
Once you have successfully built the docs, you are ready to [write documentation](write_docs.md).
13+
Once you have successfully built the docs, you are ready to [write documentation](write-docs.md).
1414

1515
{% endblock %}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Adding change information for release notes
22

3-
{% extends "contribute/how/change_note.md" %}
3+
{% extends "contribute/how/change-note.md" %}
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Setting up a development environment
2+
3+
{% extends "contribute/how/dev-environment.md" %}

docs/en/how-to/contribute/how/dev_environment.md

Lines changed: 0 additions & 3 deletions
This file was deleted.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Submitting a new issue
2+
3+
{% extends "contribute/how/new-issue.md" %}

0 commit comments

Comments
 (0)