Skip to content

Add contribution guide series. #688

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.

Sign up for GitHub

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

Merged
freakboy3742 merged 4 commits into from
Dec 12, 2025
Merged

Add contribution guide series. #688

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
59437fb
Add contribution guide series.
kattni Dec 12, 2025
8476699
Add changenote.
kattni Dec 12, 2025
8c8ad53
Spelling.
kattni Dec 12, 2025
0eadcef
Thanks, PyCharm.
kattni Dec 12, 2025
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
1 change: 1 addition & 0 deletions changes/688.doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
New contribution guide series now available in the Rubicon documentation.
7 changes: 7 additions & 0 deletions docs/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@ validation:
extra:
project_name: rubicon-objc
package_name: rubicon-objc
formal_name: Rubicon ObjC
macos_only: true
hide_coverage: true
min_python_version: "3.10" # The oldest supported Python version
min_python_version_tag: "310" # The tag version of the minimum python version
recent_python_version: "3.13" # The newest Python version known to work on all platforms
docs_python_version: "3.13" # The version of Python required to build the documentation
social:
- icon: fontawesome/brands/github
link: https://github.com/beeware
Expand Down
30 changes: 28 additions & 2 deletions docs/en/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,34 @@
- [Tutorial 2 - Writing your own class](tutorial/tutorial-2.md)
- [How-to guides](how-to/index.md)
- [Contributing to Rubicon ObjC](how-to/contribute/index.md)
- [Contributing code to Rubicon ObjC](how-to/contribute/code.md)
- [Contributing to the documentation](how-to/contribute/docs.md)
- [First-time contributors](how-to/contribute/first_time_contributors.md)
- What can I do?
- [Fix an issue](how-to/contribute/what/fix_issue.md)
- [Implement a new feature](how-to/contribute/what/implement_feature.md)
- [Write documentation](how-to/contribute/what/write_docs.md)
- [Triage an issue](how-to/contribute/what/triage.md)
- [Review a pull request](how-to/contribute/what/review_pr.md)
- [Propose a new feature](how-to/contribute/what/propose_feature.md)
- [Use the tools](how-to/contribute/what/use_tools.md)
- How do I contribute?
- [Setting up a development environment](how-to/contribute/how/dev_environment.md)
- [Reproducing an issue](how-to/contribute/how/reproduce_issue.md)
- [Working from a branch](how-to/contribute/how/branches.md)
- [Avoiding scope creep](how-to/contribute/how/scope_creep.md)
- [Writing, running, and testing code](how-to/contribute/how/write_code.md)
- [Building documentation](how-to/contribute/how/build_docs.md)
- [Writing documentation](how-to/contribute/how/write_docs.md)
- [Adding a change note](how-to/contribute/how/change_note.md)
- [Submitting a pull request](how-to/contribute/how/submit_pr.md)
- [Providing a review](how-to/contribute/how/review_pr.md)
- [Submitting a new issue](how-to/contribute/how/new_issue.md)
- [Proposing a new feature](how-to/contribute/how/propose_feature.md)
- What happens next?
- [Pull request review process](how-to/contribute/next/pr_review.md)
- [Release process](how-to/contribute/next/release.md)
- Style guides
- [Code style guide](how-to/contribute/style/code_style_guide.md)
- [Documentation style guide](how-to/contribute/style/docs_style_guide.md)
- Internal How-to guides
- [How to cut a Rubicon ObjC release](how-to/internal/release.md)
- [Topic guides](topics/index.md)
Expand Down
86 changes: 0 additions & 86 deletions docs/en/how-to/contribute/code.md
View file
Open in desktop

This file was deleted.

86 changes: 0 additions & 86 deletions docs/en/how-to/contribute/docs.md
View file
Open in desktop

This file was deleted.

3 changes: 3 additions & 0 deletions docs/en/how-to/contribute/first_time_contributors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# First-time contributors

{% extends "contribute/first_time_contributors.md" %}
3 changes: 3 additions & 0 deletions docs/en/how-to/contribute/how/branches.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Work from a feature branch, not your `main` branch

{% extends "contribute/how/branches.md" %}
15 changes: 15 additions & 0 deletions docs/en/how-to/contribute/how/build_docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Building documentation

{% extends "contribute/how/build_docs.md" %}

{% block front_matter %}

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

{% endblock %}

{% block end_matter %}

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

{% endblock %}
3 changes: 3 additions & 0 deletions docs/en/how-to/contribute/how/change_note.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Adding change information for release notes

{% extends "contribute/how/change_note.md" %}
3 changes: 3 additions & 0 deletions docs/en/how-to/contribute/how/dev_environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Setting up a development environment

{% extends "contribute/how/dev_environment.md" %}
3 changes: 3 additions & 0 deletions docs/en/how-to/contribute/how/new_issue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Submitting a new issue

{% extends "contribute/how/new_issue.md" %}
9 changes: 9 additions & 0 deletions docs/en/how-to/contribute/how/propose_feature.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Proposing a new feature

{% extends "contribute/how/propose_feature.md" %}

{% block end_matter %}

If you are interested, you can begin [implementing your new feature](../what/implement_feature.md).

{% endblock %}
15 changes: 15 additions & 0 deletions docs/en/how-to/contribute/how/reproduce_issue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Reproducing an issue

{% extends "contribute/how/reproduce_issue.md" %}

{% block front_matter %}

To begin reproducing an issue, you will need a [development environment](dev_environment.md) set up.

{% endblock %}

{% block end_matter %}

At this point, you might choose to try to [fix the issue](../what/fix_issue.md) you've just reproduced; alternatively, you can write up your findings and try to reproduce another issue.

{% endblock %}
3 changes: 3 additions & 0 deletions docs/en/how-to/contribute/how/review_pr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Providing a pull request review

{% extends "contribute/how/review_pr.md" %}
3 changes: 3 additions & 0 deletions docs/en/how-to/contribute/how/scope_creep.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Avoiding scope creep

{% extends "contribute/how/scope_creep.md" %}
17 changes: 17 additions & 0 deletions docs/en/how-to/contribute/how/submit_pr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Submitting a pull request

{% extends "contribute/how/submit_pr.md" %}

{% block end_matter %}

{% if config.extra.website %}

Your pull request may require additional content, such as a [change note](change_note.md), before it can be [reviewed](../next/pr_review.md).

{% else %}

As part of submitting a pull request, you'll need to include a [change note](change_note.md) before it can be [reviewed](../next/pr_review.md).

{% endif %}

{% endblock %}
15 changes: 15 additions & 0 deletions docs/en/how-to/contribute/how/write_code.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Writing, running, and testing code

{% extends "contribute/how/write_code.md" %}

{% block front_matter %}

To begin working on code, ensure you have a [development environment](dev_environment.md) set up, and you are [working on a branch](branches.md)

{% endblock %}

{% block end_matter %}

Once you have everything working, you can [submit a pull request](submit_pr.md) with your changes.

{% endblock %}
15 changes: 15 additions & 0 deletions docs/en/how-to/contribute/how/write_docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Writing documentation

{% extends "contribute/how/write_docs.md" %}

{% block front_matter %}

Before you begin writing documentation, ensure you are able to [build the documentation](build_docs.md), and you are [working on a branch](branches.md).

{% endblock %}

{% block end_matter %}

Once you are happy with your new documentation, you can [submit a pull request](submit_pr.md) with your proposed changes.

{% endblock %}
12 changes: 2 additions & 10 deletions docs/en/how-to/contribute/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,3 @@
# Contributing to Rubicon ObjC
# Contributing to {{ formal_name }}

There are lots of ways to contribute to Rubicon. The following are guides to getting started with the contribution process.

## [Contributing code to Rubicon](code.md)

Is there a feature you'd like to see in Rubicon? Have you found a bug that you'd like to fix? Or are you just looking for a challenge to exercise your Python skills? Here's how to get involved!

## [Contributing to Rubicon's documentation](docs.md)

You might have the best software in the world - but if nobody knows how to use it, what's the point? Documentation can always be improved - and we need your help!
{% extends "contribute/index.md" %}
3 changes: 3 additions & 0 deletions docs/en/how-to/contribute/next/pr_review.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Receiving a pull request review

{% extends "contribute/next/pr_review.md" %}
3 changes: 3 additions & 0 deletions docs/en/how-to/contribute/next/release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# The release process

{% extends "contribute/next/release.md" %}
3 changes: 3 additions & 0 deletions docs/en/how-to/contribute/style/code_style_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Code style guide

{% extends "contribute/style/code_style_guide.md" %}
3 changes: 3 additions & 0 deletions docs/en/how-to/contribute/style/docs_style_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Documentation style guide

{% extends "contribute/style/docs_style_guide.md" %}
3 changes: 3 additions & 0 deletions docs/en/how-to/contribute/what/fix_issue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Fixing an issue

{% extends "contribute/what/fix_issue.md" %}
3 changes: 3 additions & 0 deletions docs/en/how-to/contribute/what/implement_feature.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Implementing a new feature

{% extends "contribute/what/implement_feature.md" %}
3 changes: 3 additions & 0 deletions docs/en/how-to/contribute/what/propose_feature.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Proposing a new feature

{% extends "contribute/what/propose_feature.md" %}
3 changes: 3 additions & 0 deletions docs/en/how-to/contribute/what/review_pr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Providing a pull request review

{% extends "contribute/what/review_pr.md" %}
3 changes: 3 additions & 0 deletions docs/en/how-to/contribute/what/triage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Triaging an issue

{% extends "contribute/what/triage.md" %}
Loading