You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@apex.apache.org by an...@apache.org on 2015/10/15 23:55:55 UTC
incubator-apex-site git commit: improvements to contributing
guidelines
Repository: incubator-apex-site
Updated Branches:
refs/heads/master 59da7165b -> dc5e12f80
improvements to contributing guidelines
Project: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/commit/dc5e12f8
Tree: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/tree/dc5e12f8
Diff: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/diff/dc5e12f8
Branch: refs/heads/master
Commit: dc5e12f80bf9c534853446f547a0b23d7465fe7b
Parents: 59da716
Author: Andy Perlitch <an...@datatorrent.com>
Authored: Thu Oct 15 14:35:27 2015 -0700
Committer: Andy Perlitch <an...@datatorrent.com>
Committed: Thu Oct 15 14:55:39 2015 -0700
----------------------------------------------------------------------
src/md/community.md | 2 +-
src/md/contributing.md | 37 +++++++++++++++++++++++++
src/md/github_prs.md | 37 -------------------------
src/pages/contributing.html | 9 ++++++
src/pages/github-mirror-pull-requests.html | 18 ++++++------
5 files changed, 56 insertions(+), 47 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/dc5e12f8/src/md/community.md
----------------------------------------------------------------------
diff --git a/src/md/community.md b/src/md/community.md
index 99b5758..f1d9581 100644
--- a/src/md/community.md
+++ b/src/md/community.md
@@ -15,7 +15,7 @@ The Apex Project is made up of two repositories:
- [Apex Core](https://github.com/apache/incubator-apex-core) - The core of the Apex platform.
- [Apex Malhar](https://github.com/apache/incubator-apex-malhar) - Community-driven set of open-source "operators" and utilities for use in your Apex applications.
-To learn more about how we use Github to accept contributions to the project, [check out this doc](/github-mirror-pull-requests.html).
+**To learn more about how we use Github to accept contributions to the project, [check out the contributing guidelines](/contributing.html).**
## Issue Tracking
http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/dc5e12f8/src/md/contributing.md
----------------------------------------------------------------------
diff --git a/src/md/contributing.md b/src/md/contributing.md
new file mode 100644
index 0000000..f7ccad1
--- /dev/null
+++ b/src/md/contributing.md
@@ -0,0 +1,37 @@
+# Contributing Guidelines
+
+The apex core and apex malhar repositories both have mirror repositories on github which are used to review Pull Requests and provide a second remote endpoint for the codebase.
+
+
+
+## Opening a Pull Request (contributors)
+
+This project welcomes new contributors. If you would like to help by adding new features, enhancements or fixing bugs, here is how to do it.
+
+1. Create a [JIRA](https://malhar.atlassian.net/) for the work you plan to do (or assign yourself to an existing JIRA ticket)
+1. Fork the ASF github mirror (one time step):
+ https://github.com/apache/incubator-apex-core/
+1. Create a new branch from the [devel-3](https://github.com/apache/incubator-apex-core/tree/devel-3) branch. **Name your branch with the JIRA number in it, e.g. `APEX-123.my-feature`.**
+1. When adding new files, please include the Apache v2.0 license header.
+ - From the top level directory, run `mvn license:check -Dlicense.skip=false` to check correct header formatting.
+ - Run `mvn license:format -Dlicense.skip=false` to automatically add the header when missing.
+1. Once your feature is complete, submit the pull request on github against `devel-3`.
+1. If you want specific people to review your pull request, use the `@` notation in Github comments to mention that user, and request that he/she reviews your changes.
+1. After all review is complete, combine all new commits into one squashed commit, and include the Jira number in the commit message. There are several ways to squash commits, but [here is one explanation from git-scm.com](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Squashing-Commits).
+
+Thanks for contributing!
+
+## Merging a Pull Request (committers)
+
+1. Ensure that the basic requirements for a pull request are met. This includes:
+ - Commit messages need to reference JIRA (pull requests will be linked to ticket)
+ - Travis CI pull request build needs to pass
+ - Ensure tests are added/modified for new features or fixes
+ - Ensure appropriate JavaDoc comments have been added
+1. To set up access to the ASF source repository, [follow these steps](https://git-wip-us.apache.org/#committers-getting-started). The ASF master repository is: `https://git-wip-us.apache.org/repos/asf/incubator-apex-core.git`
+1. Use the git command line to pull in the changes from the pull requests. You can refer to the corresponding email that will be automatically sent to the `dev@apex.incubator.apache.org` mailing list to see the exact commands to merge the given pull request.
+1. Once done with verification, push the changes to the ASF repository's `devel-3` branch. Within a few
+seconds, the changes will propagate back to the github mirror and the pull requests be closed and marked merged automatically.
+1. The `Fix version` field on the corresponding JIRA ticket needs to be set after pushing the changes.
+
+**Note: since none of us has write access to the mirror, only the author of a pull request can close it if it was not merged.**
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/dc5e12f8/src/md/github_prs.md
----------------------------------------------------------------------
diff --git a/src/md/github_prs.md b/src/md/github_prs.md
deleted file mode 100644
index a7389fa..0000000
--- a/src/md/github_prs.md
+++ /dev/null
@@ -1,37 +0,0 @@
-# Submitting and Merging Pull Requests via the Github Mirror
-
-The apex core and apex malhar repositories both have mirror repositories on github which are used to review Pull Requests and provide a second remote endpoint for the codebase.
-
-
-
-## Opening a Pull Request
-
-Fork the ASF github mirror:
-
-https://github.com/apache/incubator-apex-core/
-
-You can then update your local repository to add the new fork as remote. No
-need for another clone or to recreate your workspace.
-
-Once your feature is complete, submit the pull request. Some additional notes:
-
-- Commit messages need to reference JIRA (pull requests will be linked to ticket)
-- Travis CI pull request build needs to pass
-- Fix version needs to be set after pushing changes
-
-## Merging a Pull Request (must be a committer)
-
-The ASF master repository is: `https://git-wip-us.apache.org/repos/asf/incubator-apex-core.git`
-
-Access: [https://git-wip-us.apache.org/#committers-getting-started](https://git-wip-us.apache.org/#committers-getting-started)
-
-Use the command line to pull in the changes from the pull requests. Since
-the github mirror is readonly, you will not be shown the convenient command
-line instructions :-( Good opportunity to remember the git commands!
-
-Once done with verification, push the changes to the master. Within a few
-seconds, the changes will propagate back to the github mirror and the pull
-requests be closed and marked merged.
-
-**Note: since none of us has write access to the mirror, only the author of a
-pull request can close it.**
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/dc5e12f8/src/pages/contributing.html
----------------------------------------------------------------------
diff --git a/src/pages/contributing.html b/src/pages/contributing.html
new file mode 100644
index 0000000..04eff32
--- /dev/null
+++ b/src/pages/contributing.html
@@ -0,0 +1,9 @@
+{{> header}}
+
+<div class="container">
+
+ {{> contributing}}
+
+</div>
+
+{{> footer}}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/dc5e12f8/src/pages/github-mirror-pull-requests.html
----------------------------------------------------------------------
diff --git a/src/pages/github-mirror-pull-requests.html b/src/pages/github-mirror-pull-requests.html
index 55d2f2c..4dfbd35 100644
--- a/src/pages/github-mirror-pull-requests.html
+++ b/src/pages/github-mirror-pull-requests.html
@@ -1,9 +1,9 @@
-{{> header}}
-
-<div class="container">
-
- {{> github_prs}}
-
-</div>
-
-{{> footer}}
\ No newline at end of file
+<html>
+ <head>
+ <title>Redirecting...</title>
+ <meta http-equiv="refresh" content="5;URL=/contributing.html">
+ </head>
+ <body bgcolor="#ffffff">
+ <center>The contributing guidelines have moved to <a href="/contributing.html">/contributing.html</a>. You will be redirected in 5 seconds. Please bookmark the new location.</center>
+ </body>
+</html>