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

Update contributing docs with current practice #551

Merged
merged 5 commits into from
Jan 30, 2024
Merged
Show file tree
Hide file tree
Changes from 4 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
26 changes: 18 additions & 8 deletions content/contributing/challenge-coins/contents.lr
Original file line number Diff line number Diff line change
Expand Up @@ -8,33 +8,43 @@ summary: What is a challenge coin, and why do you want one?
---
body:

Challenge Coins are a military tradition, which is said to originate at the start of last century. They were distributed based on merit in events or for other reasons, and hold deep personal value.
Challenge Coins are a military tradition, which is said to originate at the
start of last century. They were distributed based on merit in events or for
other reasons, and hold deep personal value.

To find out more about Challenge Coins, you can listen to the `99% Invisible`_ podcast about them, or read up about them on `Wikipedia`_.
To find out more about Challenge Coins, you can listen to the `99% Invisible`_
podcast about them, or read up about them on `Wikipedia`_.

.. figure:: /contributing/challenge-coins/challenge-coin.jpg
:alt: The front and back of the BeeWare Challenge Coin.

*The front and back of the BeeWare Challenge Coin.*

The BeeWare Challenge Coins are die cast, 4.5cm (1 3/4") in diameter, and are made of a nickel/zinc alloy with enamel highlights.
The BeeWare Challenge Coins are die cast, 4.5cm (1 3/4") in diameter, and are
made of a nickel/zinc alloy with enamel highlights.

Any contribution to the BeeWare project earns you a coin.

It doesn't have to be a code contribution: a documentation update counts. A blog post. Helping someone during a sprint with their contribution.
It doesn't have to be a code contribution: a documentation update counts. A
blog post. Helping someone during a sprint with their contribution.

And as an additional incentive, for those people who help others get their challenge coins, we have a second coin: the Yak Herder
And as an additional incentive, for those people who help others get their
challenge coins, we have a second coin: the Yak Herder

.. figure:: /contributing/challenge-coins/yak-herder-coin.jpg
:alt: The front and back of the BeeWare Yak Herder Coin.

*The front and back of the BeeWare Yak Herder Coin.*

The first run of 100 BeeWare Challenge Coins were commissioned thanks to financial support from `MaxCDN`_. They also wrote an `article about BeeWare`_ on their blog.
The first run of 100 BeeWare Challenge Coins were commissioned thanks to
financial support from `MaxCDN`_. They also wrote an `article about BeeWare`_
on their blog.

`Revolution Systems`_ provided the funding for the second pressing of the BeeWare challenge coins.
`Revolution Systems`_ provided the funding for the second pressing of the
BeeWare challenge coins.

`Github`_ provided the funding for the first pressing of the BeeWare Yak Herder challenge coins.
`Github`_ provided the funding for the first pressing of the BeeWare Yak Herder
challenge coins.

.. figure:: /contributing/challenge-coins/sprint-coin.jpg
:alt: One happy BeeWare coin recipient. Photo by Atom Images
Expand Down
7 changes: 2 additions & 5 deletions content/contributing/core-team/contents.lr
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,6 @@ Bee-nevolent Dictator for Now (BDFN): `Russell Keith-Magee <https://cloudisland.
outside open source, and code/life balance and general well-being
is a very important thing to keep in mind.


Guidelines (not actual rules)
------------------------------

Expand All @@ -68,7 +67,7 @@ number of general guidelines that the team should follow:

* **Be a good representation of the project to the wider community**

* **Treat every enquiry and contribution to any BeeWare project with respect.**
* **Treat every enquiry and contribution to any BeeWare project with respect**

* Assume everyone has good intentions, even if they haven't chosen their
words well
Expand Down Expand Up @@ -102,9 +101,7 @@ number of general guidelines that the team should follow:

* Acceptance processes should be automated wherever possible

* This means tests, linting, spell checking, coverage, and more.


* This means tests, linting, spell checking, coverage, and more

Becoming an Apiarist
---------------------
Expand Down
38 changes: 24 additions & 14 deletions content/contributing/how/contents.lr
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ There are many ways to help with BeeWare.
`First-time Contributors`_
---------------------------

If you're new to the project (or even entirely new to open source in general), the best place to start is `here </contributing/how/first-time/>`__. Everyone can contribute to open source, and we're here to show you how.
If you're new to the project (or even entirely new to open source in general),
the best place to start is `here </contributing/how/first-time/>`__. Everyone
can contribute to open source, and we're here to show you how.

.. _First-time Contributors: /contributing/how/first-time/

Expand All @@ -31,7 +33,8 @@ of interest. There will usually be a couple of tickets with known
problems; any ticket is a candidate for being fixed.

If you're a first time contributor, some tickets are also tagged as
`[good first issue] <https://github.com/search?q=user%3Abeeware+label%3A%22good%20first%20issue%22+is%3Aissue+is%3Aopen&type=issues>`__.
`[good first issue]
<https://github.com/search?q=user%3Abeeware+label%3A%22good%20first%20issue%22+is%3Aissue+is%3Aopen&type=issues>`__.
These are special issues that have been selected because they're
relatively simple introductions to the project, and the BeeWare team
will mentor any first time contributor in committing a patch for
Expand All @@ -40,22 +43,30 @@ one of these issues.
Platform Usage
---------------

Do you use Windows or various flavours of Linux? Are you able to install a project or application on your system? Did you run into any problems?
Do you use Windows or various flavours of Linux? Are you able to install a
project or application on your system? Did you run into any problems?

If so, please update the documentation to show how you were able to get it to work, or log an issue if you've found a bug that you can't fix.
If so, please update the documentation to show how you were able to get it to
work, or log an issue if you've found a bug that you can't fix.

Documentation
--------------

Is the documentation up to date? Do you think things could be worded differently? Are there missing sections? Do you have an idea for a tutorial that could be written? Please submit a Pull Request!
Is the documentation up to date? Do you think things could be worded
differently? Are there missing sections? Do you have an idea for a tutorial
that could be written? Please submit a pull request!

Is there anything wrong or missing from this website? Please feel free to `make
edits <https://github.com/beeware/beeware.github.io>`__ and submit a pull
request!

Help translate and update this Website
---------------------------------------

Is there anything wrong or missing from this website? Please feel free to `make edits <https://github.com/beeware/beeware.github.io>`__ and submit a pull request!

Want to help translate or update the content of this website? Visit the `translations section </contributing/how/translations>`__.

Do you speak a language other than English, and would like to help others
have better access to BeeWare documentation? Visit the
`translations section </contributing/how/translations>`__ to learn how you
can contribute translations of BeeWare documentation.

Build a real application!
--------------------------
Expand All @@ -80,13 +91,12 @@ to proceed, contact the project maintainers on
collaborating, especially with new contributors, and will gladly answer
any questions or walk you through any problems you may encounter.




---
gutter:

All Contributions Welcome
----------------------------------
--------------------------

But it's not just about code. A successful software project requires documentation, design skills, feedback and bug reports. The BeeWare community acknowledges that all contributions are important - not just the ones that come as a pull request on GitHub.
It's not just about code. A successful software project requires documentation, design
skills, feedback and bug reports. The BeeWare community acknowledges that all
contributions are important - not just the ones that come as a pull request on GitHub.
9 changes: 0 additions & 9 deletions content/contributing/how/dco/contents+es.lr

This file was deleted.

9 changes: 0 additions & 9 deletions content/contributing/how/dco/contents.lr

This file was deleted.

63 changes: 0 additions & 63 deletions content/contributing/how/dco/copyright/contents+es.lr

This file was deleted.

Loading
Loading