[
https://issues.apache.org/jira/browse/APEXCORE-534?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15493646#comment-15493646
]
ASF GitHub Bot commented on APEXCORE-534:
-----------------------------------------
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’s 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.
> Improve setup instructions in contributor guidelines
> ----------------------------------------------------
>
> Key: APEXCORE-534
> URL: https://issues.apache.org/jira/browse/APEXCORE-534
> Project: Apache Apex Core
> Issue Type: Task
> Reporter: Thomas Weise
> Assignee: Thomas Weise
>
> Improve instructions for newcomers to get started contributing.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
