WebExtensions/SummerOfCode2020: Difference between revisions

Jump to navigation Jump to search

WebExtensions/SummerOfCode2020 (view source)

Revision as of 16:45, 10 March 2020

119 bytes added ,  10 March 2020
Add "What are you looking for in a proposal?" and remove section about Mercurial.
(added section about draft proposals)
(Add "What are you looking for in a proposal?" and remove section about Mercurial.)
Line 12: Line 12:
The [https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions WebExtensions wiki page on MDN] provides the documentation needed to start to build a small extension for Firefox. You can also find more information about the Firefox extension ecosystem on [https://extensionworkshop.com https://extensionworkshop.com].
The [https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions WebExtensions wiki page on MDN] provides the documentation needed to start to build a small extension for Firefox. You can also find more information about the Firefox extension ecosystem on [https://extensionworkshop.com https://extensionworkshop.com].


Another way to get more experience on this project's topic is to look into (and/or contribute to) one of Mozilla's projects related to the WebExtensions, but you don't have contribute to these projects projects to be eligible for Google Summer of Code. For purposes of applying to GSOC, your main goal is to ''craft an excellent proposal''.
Another way to get more experience on this project's topic is to look into (and/or contribute to) one of Mozilla's projects related to the WebExtensions, but you don't have contribute to these projects projects to be eligible for Google Summer of Code. For purposes of applying to GSOC, your main goal is to [[#What_are_you_looking_for_in_a_proposal.3F|''craft an excellent proposal'']].


* You can become more familiar with the activityLog API by experimenting with the API itself. As the API is still in development, there is no official documentation available yet. The development of this API was tracked on Bugzilla at [https://bugzilla.mozilla.org/show_bug.cgi?id=1542402 Bug 1542402] (see the referenced bugs for more information).
* You can become more familiar with the activityLog API by experimenting with the API itself. As the API is still in development, there is no official documentation available yet. The development of this API was tracked on Bugzilla at [https://bugzilla.mozilla.org/show_bug.cgi?id=1542402 Bug 1542402] (see the referenced bugs for more information).
Line 19: Line 19:


* You can contribute to the WebExtensions API by looking into one of [https://bugzilla.mozilla.org/buglist.cgi?keywords=good-first-bug%2C%20&f1=assigned_to&keywords_type=allwords&o1=equals&resolution=---&query_format=advanced&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&v1=nobody%40mozilla.org&component=Android&component=Compatibility&component=Developer%20Tools&component=Experiments&component=Frontend&component=General&component=Request%20Handling&component=Storage&component=Themes&component=Untriaged&product=WebExtensions these good-first-bugs in Firefox]. Having additional experience extending or fixing bugs in the API itself is definitely a “bonus” skill for an applicant that we would appreciate and take into account, but it is absolutely not mandatory. We recommend reading our onboarding documentation to help you get started with fixing bugs in Firefox. If you have any questions or issues when setting up your developer environment, please join [https://chat.mozilla.org/ Mozilla’s Matrix instance] and ask for help in the [https://chat.mozilla.org/#/room/#introduction:mozilla.org “Introduction” room]. If you have questions on this project or issues with WebExtensions APIs, you may ask for help [https://chat.mozilla.org/#/room/#addons:mozilla.org “Add-ons” room].
* You can contribute to the WebExtensions API by looking into one of [https://bugzilla.mozilla.org/buglist.cgi?keywords=good-first-bug%2C%20&f1=assigned_to&keywords_type=allwords&o1=equals&resolution=---&query_format=advanced&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&v1=nobody%40mozilla.org&component=Android&component=Compatibility&component=Developer%20Tools&component=Experiments&component=Frontend&component=General&component=Request%20Handling&component=Storage&component=Themes&component=Untriaged&product=WebExtensions these good-first-bugs in Firefox]. Having additional experience extending or fixing bugs in the API itself is definitely a “bonus” skill for an applicant that we would appreciate and take into account, but it is absolutely not mandatory. We recommend reading our onboarding documentation to help you get started with fixing bugs in Firefox. If you have any questions or issues when setting up your developer environment, please join [https://chat.mozilla.org/ Mozilla’s Matrix instance] and ask for help in the [https://chat.mozilla.org/#/room/#introduction:mozilla.org “Introduction” room]. If you have questions on this project or issues with WebExtensions APIs, you may ask for help [https://chat.mozilla.org/#/room/#addons:mozilla.org “Add-ons” room].
== Is the project goal to build something like the extension activity log available on Chrome? ==
Yes, the project goal is to develop a feature similar to the one provided by Chrome, but it doesn’t have to be an exact copy, nor to be limited to the feature set Chrome provides (in terms of both features and UI).


== Can I send you a draft proposal to review? ==  
== Can I send you a draft proposal to review? ==  
Line 28: Line 24:
Unfortunately, due to time constraints, we are not able to review draft proposals. However, you are welcome to ask questions on Matrix.  
Unfortunately, due to time constraints, we are not able to review draft proposals. However, you are welcome to ask questions on Matrix.  


== Hg clone fails to complete successfully, is there any other way to get mozilla-central content downloaded? ==
== What are you looking for in a proposal? ==


This is usually due to connection issues.
To help with crafting a good proposal, here are some guidelines. This is ''not'' a checklist, but some of the criteria that we use in evaluating proposals.


As a workaround it is possible to manually download a bundle and use mercurial hg command to init an empty mercurial repository and unbundle the content of mozilla-central downloaded into it: [https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Source_Code/Mercurial/Bundles https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Source_Code/Mercurial/Bundles]
* Explain in your own words what the extension is supposed to be doing.
* What extension APIs do you expect to use in this project? Briefly describe the role of the API in your extension.
* What does the activityLog API provide, and what could be missing that limits the capabilities of your extension?
* Describe your implementation plan:
** How would you start off? What would you do and why?
** What features would you implement and in which order approximately?
** What are the milestones to track your progress on the project?
** What are nice-to-haves that you would like to work on if there is enough time?
* What is your availability and working style, and how can we help you to succeed in this project?


== How to use Mercurial while working on Mozilla code? ==
== Is the project goal to build something like the extension activity log available on Chrome? ==


Mike Conley wrote a very nice document that captures common usage patterns:
Yes, the project goal is to develop a feature similar to the one provided by Chrome, but it doesn’t have to be an exact copy, nor to be limited to the feature set Chrome provides (in terms of both features and UI).
[https://mikeconley.github.io/documents/How_mconley_uses_Mercurial_for_Mozilla_code https://mikeconley.github.io/documents/How_mconley_uses_Mercurial_for_Mozilla_code]
Robwu
47

edits

Retrieved from "https://wiki.mozilla.org/Special:MobileDiff/1224916"

Navigation menu