You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@apex.apache.org by tweise <gi...@git.apache.org> on 2016/09/15 00:39:32 UTC

[GitHub] apex-site pull request #50: APEXCORE-534 Improve contributor setup instructi...

GitHub user tweise opened a pull request:

    https://github.com/apache/apex-site/pull/50

    APEXCORE-534 Improve contributor setup instructions.

    @vrozov @chinmaykolhatkar review

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/tweise/apex-site APEXCORE-534

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/apex-site/pull/50.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #50
    
----
commit ceaa8eeaf67f85c3e11ee6f5547a973010d545cf
Author: Thomas Weise <th...@datatorrent.com>
Date:   2016-09-15T00:36:05Z

    APEXCORE-534 Improve contributor setup instructions.

----


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] apex-site pull request #50: APEXCORE-534 Improve contributor setup instructi...

Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:

    https://github.com/apache/apex-site/pull/50


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] apex-site pull request #50: APEXCORE-534 Improve contributor setup instructi...

Posted by chinmaykolhatkar <gi...@git.apache.org>.
Github user chinmaykolhatkar commented on a diff in the pull request:

    https://github.com/apache/apex-site/pull/50#discussion_r78984813
  
    --- Diff: src/md/contributing.md ---
    @@ -14,7 +14,38 @@ This project welcomes new contributors and invites everyone to participate. Our
     
     People that help with the project in any of the above categories or other ways are contributors. See the [roles](http://www.apache.org/foundation/how-it-works.html#roles) as defined by the ASF. Community members that make sustained, welcome contributions to the project may be invited to become a [committer](/people.html). 
     
    -## Code Style
    +## Before coding: One time Setup
    +
    +### JIRA
    +
    +Apache JIRA is used for issue tracking. If you do not already have an Apache JIRA account, sign up [here](https://issues.apache.org/jira/). Note that the user name should have no white spaces or other special characters that complicate auto-completion within JIRA comments etc. 
    +
    +Please use a single JIRA account only (don't create multiple with different email addresses) to retain the issue history. Please use a permanent email address, for an existing account it can be changed in the profile. If you absolutely have to change your user name, contact INFRA.
    +
    +Apex has 2 JIRA projects:
    +
    +1. [APEXCORE](https://issues.apache.org/jira/browse/APEXCORE/) for [apex-core](https://github.com/apache/apex-core) and [apex-site](https://github.com/apache/apex-site)
    +2. [APEXMALHAR](https://issues.apache.org/jira/browse/APEXMALHAR/) for [apex-malhar](https://github.com/apache/apex-malhar)
    +
    +Before working on changes for any of the repositories, please locate an existing JIRA ticket or submit a new one. In order to assign an issue to yourself, you need to be listed as contributor in the JIRA project. PMC members have access to add new contributors, please request to be added through a comment on the candidate ticket.
    --- End diff --
    
    Rather than adding a comment on tkt, should we ask new contributor to send a mail to dev@apex for contributor access. 
    That way, the PMC/Committers can follow up with new contributor and help the person if required. This way, he/she gets introduced to the community at the same time, existing community members gets chance to give new contributers next step.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] apex-site pull request #50: APEXCORE-534 Improve contributor setup instructi...

Posted by tweise <gi...@git.apache.org>.
Github user tweise commented on a diff in the pull request:

    https://github.com/apache/apex-site/pull/50#discussion_r78986398
  
    --- Diff: src/md/contributing.md ---
    @@ -14,7 +14,38 @@ This project welcomes new contributors and invites everyone to participate. Our
     
     People that help with the project in any of the above categories or other ways are contributors. See the [roles](http://www.apache.org/foundation/how-it-works.html#roles) as defined by the ASF. Community members that make sustained, welcome contributions to the project may be invited to become a [committer](/people.html). 
     
    -## Code Style
    +## Before coding: One time Setup
    +
    +### JIRA
    +
    +Apache JIRA is used for issue tracking. If you do not already have an Apache JIRA account, sign up [here](https://issues.apache.org/jira/). Note that the user name should have no white spaces or other special characters that complicate auto-completion within JIRA comments etc. 
    +
    +Please use a single JIRA account only (don't create multiple with different email addresses) to retain the issue history. Please use a permanent email address, for an existing account it can be changed in the profile. If you absolutely have to change your user name, contact INFRA.
    +
    +Apex has 2 JIRA projects:
    +
    +1. [APEXCORE](https://issues.apache.org/jira/browse/APEXCORE/) for [apex-core](https://github.com/apache/apex-core) and [apex-site](https://github.com/apache/apex-site)
    +2. [APEXMALHAR](https://issues.apache.org/jira/browse/APEXMALHAR/) for [apex-malhar](https://github.com/apache/apex-malhar)
    +
    +Before working on changes for any of the repositories, please locate an existing JIRA ticket or submit a new one. In order to assign an issue to yourself, you need to be listed as contributor in the JIRA project. PMC members have access to add new contributors, please request to be added through a comment on the candidate ticket.
    --- End diff --
    
    I considered that but if you are looking at a ticket, then it is easier to do it from there and it will result in an email to the dev list.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] apex-site pull request #50: APEXCORE-534 Improve contributor setup instructi...

Posted by chinmaykolhatkar <gi...@git.apache.org>.
Github user chinmaykolhatkar commented on a diff in the pull request:

    https://github.com/apache/apex-site/pull/50#discussion_r78987144
  
    --- Diff: src/md/contributing.md ---
    @@ -14,7 +14,38 @@ This project welcomes new contributors and invites everyone to participate. Our
     
     People that help with the project in any of the above categories or other ways are contributors. See the [roles](http://www.apache.org/foundation/how-it-works.html#roles) as defined by the ASF. Community members that make sustained, welcome contributions to the project may be invited to become a [committer](/people.html). 
     
    -## Code Style
    +## Before coding: One time Setup
    +
    +### JIRA
    +
    +Apache JIRA is used for issue tracking. If you do not already have an Apache JIRA account, sign up [here](https://issues.apache.org/jira/). Note that the user name should have no white spaces or other special characters that complicate auto-completion within JIRA comments etc. 
    +
    +Please use a single JIRA account only (don't create multiple with different email addresses) to retain the issue history. Please use a permanent email address, for an existing account it can be changed in the profile. If you absolutely have to change your user name, contact INFRA.
    +
    +Apex has 2 JIRA projects:
    +
    +1. [APEXCORE](https://issues.apache.org/jira/browse/APEXCORE/) for [apex-core](https://github.com/apache/apex-core) and [apex-site](https://github.com/apache/apex-site)
    +2. [APEXMALHAR](https://issues.apache.org/jira/browse/APEXMALHAR/) for [apex-malhar](https://github.com/apache/apex-malhar)
    +
    +Before working on changes for any of the repositories, please locate an existing JIRA ticket or submit a new one. In order to assign an issue to yourself, you need to be listed as contributor in the JIRA project. PMC members have access to add new contributors, please request to be added through a comment on the candidate ticket.
    +
    +### Github and git
    +
    +We use GitHub\u2019s pull request functionality to review proposed code changes. If you do not already have a personal GitHub account, sign up [here](https://github.com/join). We recommend that you use the same email address and first/lastname for emails, git and JIRA so that contributions can be better tracked and notifications correlated. It is also recommended that you use an email address that is valid permanently (for example the @apache.org address, if you have one). Please also see:
    --- End diff --
    
    In sentence "for example ....." Only committers will apache email address. That's not encouraging IMO... Rather give example as "@gmail.com"... gmail.com will most likely be personal id and not company address.. That's added advantage. :)


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] apex-site pull request #50: APEXCORE-534 Improve contributor setup instructi...

Posted by chinmaykolhatkar <gi...@git.apache.org>.
Github user chinmaykolhatkar commented on a diff in the pull request:

    https://github.com/apache/apex-site/pull/50#discussion_r78988849
  
    --- Diff: src/md/contributing.md ---
    @@ -14,7 +14,38 @@ This project welcomes new contributors and invites everyone to participate. Our
     
     People that help with the project in any of the above categories or other ways are contributors. See the [roles](http://www.apache.org/foundation/how-it-works.html#roles) as defined by the ASF. Community members that make sustained, welcome contributions to the project may be invited to become a [committer](/people.html). 
     
    -## Code Style
    +## Before coding: One time Setup
    +
    +### JIRA
    +
    +Apache JIRA is used for issue tracking. If you do not already have an Apache JIRA account, sign up [here](https://issues.apache.org/jira/). Note that the user name should have no white spaces or other special characters that complicate auto-completion within JIRA comments etc. 
    +
    +Please use a single JIRA account only (don't create multiple with different email addresses) to retain the issue history. Please use a permanent email address, for an existing account it can be changed in the profile. If you absolutely have to change your user name, contact INFRA.
    +
    +Apex has 2 JIRA projects:
    +
    +1. [APEXCORE](https://issues.apache.org/jira/browse/APEXCORE/) for [apex-core](https://github.com/apache/apex-core) and [apex-site](https://github.com/apache/apex-site)
    +2. [APEXMALHAR](https://issues.apache.org/jira/browse/APEXMALHAR/) for [apex-malhar](https://github.com/apache/apex-malhar)
    +
    +Before working on changes for any of the repositories, please locate an existing JIRA ticket or submit a new one. In order to assign an issue to yourself, you need to be listed as contributor in the JIRA project. PMC members have access to add new contributors, please request to be added through a comment on the candidate ticket.
    +
    +### Github and git
    +
    +We use GitHub\u2019s pull request functionality to review proposed code changes. If you do not already have a personal GitHub account, sign up [here](https://github.com/join). We recommend that you use the same email address and first/lastname for emails, git and JIRA so that contributions can be better tracked and notifications correlated. It is also recommended that you use an email address that is valid permanently (for example the @apache.org address, if you have one). Please also see:
    +
    +* https://help.github.com/articles/setting-your-email-in-git/
    +* https://help.github.com/articles/adding-an-email-address-to-your-github-account/
    +* https://help.github.com/articles/keeping-your-email-address-private/
    +
    +The ASF Apex git repositories have mirror repositories on github which are used to review pull requests and provide a second remote endpoint for the codebase.
    +
    +1. Fork the ASF github mirror: https://github.com/apache/apex-core (or https://github.com/apache/apex-malhar or https://github.com/apache/apex-site) 
    +1. Clone the **fork** on your local workspace (one time step):  
    +   `git clone https://github.com/{github_username}/apex-core.git`
    +1. Add the mirror as remote repository, here shown for apex-core:  
    +   `git remote add upstream https://github.com/apache/apex-core`
    +
    --- End diff --
    
    We need to add a section for prereq for development with apex:
    Here is the list I can think about:
    1. mvn.. min version 3.0.5
    2. jdk.. 7 preferred
    3. IDE being popularly used by developers (IntelliJ, Eclipse, Netbeans)... Also should mention no such restriction. One can code in vi as well is he/she is happy.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] apex-site pull request #50: APEXCORE-534 Improve contributor setup instructi...

Posted by chinmaykolhatkar <gi...@git.apache.org>.
Github user chinmaykolhatkar commented on a diff in the pull request:

    https://github.com/apache/apex-site/pull/50#discussion_r78988135
  
    --- Diff: src/md/contributing.md ---
    @@ -14,7 +14,38 @@ This project welcomes new contributors and invites everyone to participate. Our
     
     People that help with the project in any of the above categories or other ways are contributors. See the [roles](http://www.apache.org/foundation/how-it-works.html#roles) as defined by the ASF. Community members that make sustained, welcome contributions to the project may be invited to become a [committer](/people.html). 
     
    -## Code Style
    +## Before coding: One time Setup
    +
    +### JIRA
    +
    +Apache JIRA is used for issue tracking. If you do not already have an Apache JIRA account, sign up [here](https://issues.apache.org/jira/). Note that the user name should have no white spaces or other special characters that complicate auto-completion within JIRA comments etc. 
    +
    +Please use a single JIRA account only (don't create multiple with different email addresses) to retain the issue history. Please use a permanent email address, for an existing account it can be changed in the profile. If you absolutely have to change your user name, contact INFRA.
    +
    +Apex has 2 JIRA projects:
    +
    +1. [APEXCORE](https://issues.apache.org/jira/browse/APEXCORE/) for [apex-core](https://github.com/apache/apex-core) and [apex-site](https://github.com/apache/apex-site)
    +2. [APEXMALHAR](https://issues.apache.org/jira/browse/APEXMALHAR/) for [apex-malhar](https://github.com/apache/apex-malhar)
    +
    +Before working on changes for any of the repositories, please locate an existing JIRA ticket or submit a new one. In order to assign an issue to yourself, you need to be listed as contributor in the JIRA project. PMC members have access to add new contributors, please request to be added through a comment on the candidate ticket.
    +
    +### Github and git
    +
    +We use GitHub\u2019s pull request functionality to review proposed code changes. If you do not already have a personal GitHub account, sign up [here](https://github.com/join). We recommend that you use the same email address and first/lastname for emails, git and JIRA so that contributions can be better tracked and notifications correlated. It is also recommended that you use an email address that is valid permanently (for example the @apache.org address, if you have one). Please also see:
    +
    +* https://help.github.com/articles/setting-your-email-in-git/
    +* https://help.github.com/articles/adding-an-email-address-to-your-github-account/
    +* https://help.github.com/articles/keeping-your-email-address-private/
    +
    +The ASF Apex git repositories have mirror repositories on github which are used to review pull requests and provide a second remote endpoint for the codebase.
    +
    +1. Fork the ASF github mirror: https://github.com/apache/apex-core (or https://github.com/apache/apex-malhar or https://github.com/apache/apex-site) 
    +1. Clone the **fork** on your local workspace (one time step):  
    --- End diff --
    
    I guess we can add a link to git tutorial (https://try.github.io/). For those who had been non-git users till now.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---