Dear Wiki user, You have subscribed to a wiki page or wiki category on "Cordova Wiki" for change notification.
The "ContributorWorkflow" page has been changed by MarcelKinard: https://wiki.apache.org/cordova/ContributorWorkflow?action=diff&rev1=32&rev2=33 Comment: add some more verbage on "Getting Noticed" However, contributors should typically fork from !GitHub. This makes it easy to submit pull requests, which is the preferred method to make contributions as a non-committer. So as a contributor you should: 1. Create an account on github.com. Note that your repositories will have a URL of the form 'https://github.com/you' where the string 'you' is your userid. For the exercise here, substitute 'you' with your github userid. The official github repos that are read-only are at https://github.com/apache. - 1. Note that Cordova has each component in a separate git repository, so there are many git repositories that compromise the entire project. They all start with "cordova-". So for this exercise we will use the fake name "cordova-x", which you should replace with the specific repository(s) you want to work with, such as "cordova-docs" or "cordova-android". The full list is on [[http://cordova.apache.org|the Cordova home page]]. + 1. Note that Cordova has each component in a separate git repository, so there are many git repositories that compromise the entire project. They all start with "cordova-". So for this exercise we will use the fake name "cordova-x", which you should replace with the specific repository(s) you want to work with, such as "cordova-docs" or "cordova-android". The full list is on [[http://cordova.apache.org|the Cordova home page]]. Note that all of the 18 core plugins are each in their own separate repo. This does make for more repos than you may be used to. 1. On the !GitHub web interface, fork github.com/apache/cordova-x.git to your own account on !GitHub (ie, github.com/you/cordova-x.git). 1. From your workstation, clone your !GitHub repo (ie, github.com/you/cordova-x.git) to your workstation. For example, to clone a Cordova repository, from your workstation shell you would run (note the "https" protocol): {{{ @@ -80, +80 @@ Maintainers like topic branches. It is easier to review the pull request and merge commits into the main repository. == Git Workflow == - Consider that you've decided to work on ticket # CB-1234 for the cordova-docs repository. You are charged with updating some documentation. + Consider that you've decided to work on ticket # CB-1234 for the cordova-x repository. You are charged with updating some documentation. === Update your master branch === We're assuming you have cloned the docs repository as per the example above, and have the docs repository set up as a "apache" remote, with your own fork as the "origin". Let's first make sure your fork is up-to-date. @@ -182, +182 @@ $ git push origin CB-1234 }}} == Sharing your Changes == - By pushing your topic branch onto your fork, an cordova-docs maintainer can review and merge the topic branch into the main repository. + By pushing your topic branch onto your fork, a cordova-x committer can review and merge your topic branch into the main repository. === Sending a Pull Request from GitHub === Pull requests sent to the [[http://github.com/apache|Apache GitHub repositories]] are used to take contributions. - * Open a web browser to your GitHub account's cordova-docs fork. + * Open a web browser to your GitHub account's cordova-x fork. * Select your topic branch so that the pull request references the topic branch. * Click the Pull Request button. === Getting Noticed === It is strongly recommended that you sign up for the [[http://cordova.apache.org/#mailing-list|mailing list]] before issuing a pull request. If your pull request is related to an existing JIRA issue, then add a comment to the issue with a link to your pull request. If it's not (or you're feeling too lazy to search through JIRA), then you should email the mailing-list to notify committers of your pull request. + + Adding the URL of your pull request into the Jira item with some verbage saying it is ready will help notify a committer that your topic branch is ready. Most committers will get email notifications regarding all Jira items. You may also want to send an email to the mailing list explaining what your changes do and advocating for it. + + Review Board is a tool for committers to review each others' changes. As a contributor generally you won't use Review Board - the pull request should be sufficient. + + A list of the lead committers for each component can be found [[https://issues.apache.org/jira/browse/CB#selectedTab=com.atlassian.jira.plugin.system.project%3Acomponents-panel|listed in Jira]]. But generally you should send an email to the whole mailing list, not to the individual lead committers because this is a community. == While Waiting, Continuing Crafting Commits == Since you worked on the topic branch instead of the master branch, you can continue working while waiting for the pull request to go through.
