Marketplace/Contributing/Code: Difference between revisions

m (program end)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
We love contributions to the marketplace.firefox.com codebase! We have a formal onboarding process to ensure you are getting the most out of your experience, and to help you work well with other staff and volunteer developers.
{{Marketplace_banner}}
'''''The following contribution program has ended.'''''


=Steps to Onboard=
=Steps to Onboard=
Line 6: Line 7:
Please create accounts on the following sites, if you haven't already:
Please create accounts on the following sites, if you haven't already:
*https://bugzilla.mozilla.org/
*https://bugzilla.mozilla.org/
**Be sure to set a [:nick] for your account. Go to https://bugzilla.mozilla.org/userprefs.cgi?tab=account and in the "Your real name" field, add it next to your name. Example: Amy Tsay [:amyt]
*http://github.com
*http://github.com


==Step 2: Tell us a little about yourself==
==Step 2: Tell us a little about yourself==
Please fill out a [https://docs.google.com/a/mozilla.com/forms/d/1MclAjxalrYGFXgGn7oa3RSFCGp7NB-lDmV6z9fnUH_w/viewform short survey] so we can better connect you to the right opportunities.
Please fill out a survey so we can better connect you to the right opportunities. We may reach out to you if there is a particular project that fits your skills, but in the meantime please move on to step #3.


==Step 3: Familiarize yourself with the on-boarding materials==
==Step 3: Familiarize yourself with the on-boarding materials==


# Intro to contributing a patch to Firefox Marketplace: http://micropipes.com/blog//2014/10/31/contributing-a-patch-to-the-firefox-marketplace-from-scratch/
# [http://micropipes.com/blog//2014/10/31/contributing-a-patch-to-the-firefox-marketplace-from-scratch/ Intro to contributing a patch to Firefox Marketplace]
# Setting up the frontend development environment: https://marketplace-frontend.readthedocs.org/en/latest/  
# [https://docs.google.com/document/d/1EFE6beSAxcR5SHhx6nrNMjQiLBeIrohyEZD5B1FMsl8/edit GitHub Best Practices]
# Working with Marketplace code: (TBD - Notes: https://etherpad.mozilla.org/how-to-work-with-mp-code)
# [https://docs.google.com/document/d/1s5PuZB-YkK6iP-e3u_QrUzAQUQbsWpvVnuHudA9E6BA/edit Working with Marketplace developers]
# Working with Marketplace developers: (TBD - Notes: https://etherpad.mozilla.org/how-to-work-with-mp-devs)
# [https://marketplace-frontend.readthedocs.org/en/latest/topics/guidelines.html Coding styleguide]
# Coding styleguide: https://marketplace-frontend.readthedocs.org/en/latest/topics/guidelines.html
# Review checklist--pass your code review: https://developer.mozilla.org/docs/Mozilla/Developer_guide/Reviewer_Checklist


==Step 4: Set up a development environment on your local machine==
==Step 4: Set up a development environment on your local machine==
If you run into any issues or have questions, please go here for help: https://discourse.mozilla-community.org/c/firefox-marketplace. Or, jump into the #Marketplace channel on irc.mozilla.org.
Our [https://marketplace-frontend.readthedocs.org/en/latest/ documentation] provides step-by-step instructions on how to set up your local development environment. (Have Windows? Learn how to install [http://sumantrom.blogspot.in/2015/08/fireplace-for-windows.html Fireplace on Windows]). If you run into any issues or have questions, please [https://discourse.mozilla-community.org/c/firefox-marketplace go here] for help. Or, jump into the #Marketplace channel on irc.mozilla.org.


==Step 5: Select a "goodfirstbug" to work on==
==Step 5: Select a "goodfirstbug" to work on==
Line 32: Line 30:


==Get recognized==
==Get recognized==
When your first pull request is merged, please report it here so we can properly celebrate your first contribution! https://wiki.mozilla.org/Marketplace/Contributing/ThisMonth#Get_Recognized
When your first pull request is merged, please [https://wiki.mozilla.org/Marketplace/Contributing/Recognition report it here] so we can properly celebrate your first contribution!


==Pick another bug==
==Pick another bug==
Line 39: Line 37:
==Need guidance?==
==Need guidance?==
Please feel free to reach out to one of our community mentors! The two best ways to reach out are:
Please feel free to reach out to one of our community mentors! The two best ways to reach out are:
* irc.mozilla.com - #marketplace channel; mentors are given "voice" in the #marketplace channel, so should float to the top in most clients
* irc.mozilla.com - #marketplace channel; mentors are given "voice" in the channel, so should float to the top in most clients
* Code contributor forum: https://discourse.mozilla-community.org/c/firefox-marketplace
* Code contributor forum: https://discourse.mozilla-community.org/c/firefox-marketplace
Volunteer mentors
Volunteer code mentors
* '''[https://mozillians.org/u/gurumukhi/ Ram Dayal Vaishnav] (IRC handle: ramd)
* '''[https://mozillians.org/u/gurumukhi/ Ram Dayal Vaishnav] (IRC handle: ramd)
* '''[https://mozillians.org/u/atiqueahmedziad/ Atique Ahmed Ziad] (IRC handle: atiqueahmedziad)
* '''[https://mozillians.org/u/atiqueahmedziad/ Atique Ahmed Ziad] (IRC handle: atiqueahmedziad)
* '''[https://mozillians.org/u/trishul/ Trishul Goel] (IRC handle: trishul)
* '''[https://mozillians.org/u/trishul/ Trishul Goel] (IRC handle: trishul)

Latest revision as of 22:31, 14 April 2016

Stop (medium size).png
The Marketplace has been placed into maintenance mode. It is no longer under active development. You can read complete details here.

The following contribution program has ended.

Steps to Onboard

Step 1: Create some accounts

Please create accounts on the following sites, if you haven't already:

Step 2: Tell us a little about yourself

Please fill out a survey so we can better connect you to the right opportunities. We may reach out to you if there is a particular project that fits your skills, but in the meantime please move on to step #3.

Step 3: Familiarize yourself with the on-boarding materials

  1. Intro to contributing a patch to Firefox Marketplace
  2. GitHub Best Practices
  3. Working with Marketplace developers
  4. Coding styleguide

Step 4: Set up a development environment on your local machine

Our documentation provides step-by-step instructions on how to set up your local development environment. (Have Windows? Learn how to install Fireplace on Windows). If you run into any issues or have questions, please go here for help. Or, jump into the #Marketplace channel on irc.mozilla.org.

Step 5: Select a "goodfirstbug" to work on

Once your dev environment is set up, go to this link to see a list of bugs that are marked as good for first time contributors. If no one else is working on the bug, please leave a comment to let the mentor know you are going to work on it. If someone is working on it but there hasn't been activity for a while, feel free to ask permission by leaving a comment.

Alternatively, we may reach out to you to suggest a bug for you to work on, based on what you indicated in the contributor survey.

What's Next?

Get recognized

When your first pull request is merged, please report it here so we can properly celebrate your first contribution!

Pick another bug

Select another “goodfirstbug” to get more practice, or move on to a “goodsecondbug”!

Need guidance?

Please feel free to reach out to one of our community mentors! The two best ways to reach out are:

Volunteer code mentors