#721 docs: Expand "Start on a task" section to be more specific
Merged 2 years ago by jflory7. Opened 2 years ago by jflory7.

@@ -80,21 +80,68 @@ 


  == Start on a task


- The Fedora Badges community tracks tasks and what we are working on in two places:

+ There are three ways to contribute to Fedora Badges:


- * Badges design: https://pagure.io/fedora-badges/issues[pagure.io/fedora-badges]

- * Badges development: https://github.com/fedora-infra/badgr-server[github.com/fedora-infra/badgr-server]

+ * As a designer

+ * As a developer

+ * As a system administrator


+ Before you begin any of the following tasks, https://lists.fedoraproject.org/admin/lists/badges.lists.fedoraproject.org/[introduce yourself on the mailing list]!


+ === As a designer


+ The Fedora Badges community accepts requests for new badges in a public issue tracker on https://pagure.io/fedora-badges/issues[pagure.io/fedora-badges].

+ The community opens an issue there when they have a new idea for a badge.

+ To get started with badge design, follow these steps:


+ . Review xref::design-badges.adoc[How to design a Fedora Badge] documentation

+ . Set up Inkscape with Badges color palettes, fonts, and templates (provided in documentation)

+ . Review Badge tickets tagged as https://pagure.io/fedora-badges/issues?status=Open&tags=artwork+-+needed[artwork - needed]

+ . If nobody is assigned to the issue, leave a comment that you want to work on the Badge artwork

+ . A Badges contributor will reply to confirm the Badge is possible and ready to be worked on (we don't want you to make a design for a Badge that isn't technically possible!)

+ . Begin designing the badge, post SVGs/PNGs of your artwork to the issue for review


+ === As a developer


+ _NOTE_: This section is specific to Outreachy Summer 2020 applicants.


+ You can also contribute code to the Fedora Badges project.

+ There are two git repositories to contribute code:


+ * *Upstream*: https://github.com/concentricsky/badgr-server[github.com/concentricsky/badgr-server]

+ * *Our fork*: https://github.com/fedora-infra/badgr-server[github.com/fedora-infra/badgr-server]


  Tasks, problems, and goals are filed as tickets in the issue trackers.

- There are many tickets, but we're not working on everything at once.

- Scrolling through the issue tracker gives a good idea of what the Badges community is doing.

+ The upstream repository is where we submit patches and improvements to the *badgr-server* project that Fedora Badges uses.

+ Our forked repository is where we keep track of development tasks and goals specific to the Fedora Badges implementation.


+ ==== Complete mini projects


+ This Outreachy project is different from many other Outreachy projects.

+ The Fedora Badges project involves moving from a legacy framework to a new platform for the Fedora Badges web app.

+ It might sound scary, but there is a team of people ready to help!

+ So, part of the work for development includes *research tasks* before we begin writing a lot of new code.


+ Before you write code, you need to set up a development environment and learn about Fedora infrastructure tooling.

+ The Fedora Badges team identified a few "mini projects" for applicants to work on.

+ These help you learn about the tools we will work with and get more experience with other parts of Fedora's infrastructure.

+ Check out these issues to get started:


+ . https://github.com/fedora-infra/badgr-server/issues/3[fedora-infra/badgr-server#3]: Deploy a simple django application on Openshift Online

+ . https://github.com/fedora-infra/badgr-server/issues/4[fedora-infra/badgr-server#4]: Deploy a local badgr instance and see if features we want are here

+ . https://github.com/fedora-infra/badgr-server/issues/1[fedora-infra/badgr-server#1]: Install fedora-messaging locally and publish a test message


+ ==== Submit code patches


+ _NOTE_: We advise waiting until Monday, 16 March 2020 to start on code patches!

+ The recommended development environment will have major changes starting that day.


- // Look for the https://pagure.io/fedora-commops/issues?status=Open&tags=good+first+issue[good first issue] tag on tickets to find good tasks for beginners.

+ Fedora Badges is partnering with the upstream *concentricsky/badgr-server* project to submit code and documentation improvements.

+ The Concentric Sky team https://github.com/concentricsky/badgr-server/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22[tagged issues as "help wanted"] for where to start with contributing.

+ The Fedora Badges mentor team is also participating there.

+ If you are interested in working on a code patch for *concentricsky/badgr-server*, comment on the GitHub issue that you would like to work on the task.

+ If someone else has not already started, you can begin working on your pull request.


- Does something look interesting?

- Leave a comment on a ticket if you have a question or want to work on something.

- Also check and see if the ticket is assigned to someone.

- If it is unassigned, you can start on it.

- If there is an assignee, ask them if they need help or if they are still working on the ticket.

+ === As a system administrator


- This provides an opportunity to receive mentorship and get help to start a new task.

+ Coming soon…

This improves our documentation on how to get started with design and
development tasks in the Fedora Badges project. It includes a section on
the things specific to Fedora Badges but also mentions the upstream
concentricsky/badgr-server project.

I added a note that these are specific to Outreachy Summer 2020, because
it is likely this section will need to change after Outreachy. But I am
erring on the side of being too detailed and risking it becoming
outdated, instead of not being detailed enough to direct people to the
right place.

Also I skimped on the sysadmin docs, but I want to move our sysadmin
docs out of the Fedora Infra SOP and into this repo so everything lives
in one place. Once it lives here, I'll update that section too.

Screenshot of local preview with changes

Metadata Update from @jflory7:
- Pull-request tagged with: type - docs

2 years ago

We got a +1 from Otto at Concentric Sky on the upstream engagement instructions, but I want to get someone from the design and development side of Fedora Badges to also approve this before it gets merged.

rebased onto d219662

2 years ago

Got +1's in our mentor chat this morning. Merging this in. I'll update the mailing list and chat rooms with the updated docs once they publish.

Pull-Request has been merged by jflory7

2 years ago