Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,10 @@

BeeWare <3's contributions!

Please be aware, BeeWare operates under a Code of Conduct.
Please be aware that BeeWare operates under a [Code of
Conduct](https://beeware.org/community/behavior/code-of-conduct/).

See [CONTRIBUTING to BeeWare](https://beeware.org/contributing) for details.

See also the Briefcase specific contributing guides for contributing
[code](https://briefcase.readthedocs.io/en/latest/how-to/contribute-code.html)
and
[documentation](https://briefcase.readthedocs.io/en/latest/how-to/contribute-docs.html)
If you'd like to contribute to Briefcase development, our [contribution
guide](https://briefcase.readthedocs.io/en/latest/how-to/contribute/index.html) details how
to set up a development environment, and other requirements we have as part of our
contribution process.
24 changes: 12 additions & 12 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,31 +75,31 @@ tools useful, please consider becoming a financial member.
Documentation
-------------

Documentation for Briefcase can be found on `Read The Docs`_.
Documentation for Briefcase can be found on `Read The Docs
<https://briefcase.readthedocs.io>`__.

Community
---------

Briefcase is part of the `BeeWare suite`_. You can talk to the community through:
Briefcase is part of the `BeeWare suite <https://beeware.org>`__. You can talk to the
community through:

* `@[email protected] on Mastodon <https://fosstodon.org/@beeware>`__

* `Discord <https://beeware.org/bee/chat/>`__

* The Briefcase `Github Discussions forum <https://github.com/beeware/briefcase/discussions>`__

We foster a welcoming and respectful community as described in our
`BeeWare Community Code of Conduct`_.
We foster a welcoming and respectful community as described in our `BeeWare Community
Code of Conduct <https://beeware.org/community/behavior/>`__.

Contributing
------------

If you experience problems with Briefcase, `log them on GitHub`_. If you
want to contribute code, please `fork the code`_ and `submit a pull request`_.
If you experience problems with Toga, `log them on GitHub
<https://github.com/beeware/briefcase/issues>`__.

.. _BeeWare suite: https://beeware.org
.. _Read The Docs: https://briefcase.readthedocs.io
.. _BeeWare Community Code of Conduct: https://beeware.org/community/behavior/
.. _log them on Github: https://github.com/beeware/briefcase/issues
.. _fork the code: https://github.com/beeware/briefcase
.. _submit a pull request: https://github.com/beeware/briefcase/pulls
If you'd like to contribute to Toga development, our `contribution guide
<https://briefcase.readthedocs.io/en/latest/how-to/contribute/index.html>`__
details how to set up a development environment, and other requirements we have
as part of our contribution process.
1 change: 1 addition & 0 deletions changes/2237.misc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The structure of contribution documentation was normalized across BeeWare projects.
2 changes: 1 addition & 1 deletion docs/background/releases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -398,7 +398,7 @@ Features
* The base image used to build AppImages is now user-configurable. (`#947 <https://github.com/beeware/briefcase/issues/947>`__)
* Support for Arch ``.pkg.tar.zst`` packaging was added to the Linux system backend. (`#1064 <https://github.com/beeware/briefcase/issues/1064>`__)
* Pygame was added as an explicit option for a GUI toolkit. (`#1125 <https://github.com/beeware/briefcase/pull/1125>`__)
* AppImage and Flatpak builds now use `indygreg's Python Standalone Builds <https://github.com/indygreg/python-build-standalone>`__ to provide Python support. (`#1132 <https://github.com/beeware/briefcase/pull/1132>`__)
* AppImage and Flatpak builds now use `indygreg's Python Standalone Builds <https://github.com/astral-sh/python-build-standalone>`__ to provide Python support. (`#1132 <https://github.com/beeware/briefcase/pull/1132>`__)
* BeeWare now has a presence on Mastodon. (`#1142 <https://github.com/beeware/briefcase/pull/1142>`__)


Expand Down
4 changes: 2 additions & 2 deletions docs/how-to/code-signing/macOS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ charged on an annual basis.

If you're registering as a non-profit organization, an educational institution or a
government entity, you may be eligible for a fee waiver, which you can read more about
`here <https://developer.apple.com/support/membership-fee-waiver/>`__.
`here <https://developer.apple.com/help/account/membership/fee-waivers/>`__.

Generating a certificate request on Keychain Access
---------------------------------------------------
Expand Down Expand Up @@ -133,7 +133,7 @@ certificate on this page.
If you've been registered as an organization, there's a chance that
the option to choose the Developer ID Application certificate is unavailable.
This may happen if you're not assigned the role of the `Account Holder
<https://developer.apple.com/documentation/security/notarizing_macos_software_before_distribution>`__.
<https://developer.apple.com/documentation/security/notarizing-macos-software-before-distribution>`__.
You can access and change these roles using `App Store Connect
<https://appstoreconnect.apple.com/login>`__.

Expand Down
File renamed without changes.
File renamed without changes.
13 changes: 13 additions & 0 deletions docs/how-to/contribute/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
=========================
Contributing to Briefcase
=========================

Briefcase is an open source project, and actively encourages community contributions.
The following guides will help you get started contributing.

.. toctree::
:maxdepth: 2
:glob:

code
docs
3 changes: 1 addition & 2 deletions docs/how-to/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,5 @@ stand alone.
ci
publishing/index
upgrade-from-v0.2
contribute-code
contribute-docs
contribute/index
internal/index
2 changes: 1 addition & 1 deletion docs/reference/platforms/linux/docker_build_options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ A configuration argument to be passed to the Docker build command for the app
image. For example, to provide an additional build argument to the Dockerfile,
specify ``--Xdocker-build=--build-arg=ARG=value``. See `the Docker build
documentation
<https://docs.docker.com/engine/reference/commandline/image_build/#options>`__
<https://docs.docker.com/reference/cli/docker/buildx/build/#options>`__
for details on the full list of options that can be provided.

You may specify multiple ``--Xdocker-build`` arguments; each one specifies a
Expand Down