Return-Path: X-Original-To: apmail-apex-dev-archive@minotaur.apache.org Delivered-To: apmail-apex-dev-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 191A219157 for ; Mon, 14 Mar 2016 20:33:37 +0000 (UTC) Received: (qmail 93556 invoked by uid 500); 14 Mar 2016 20:33:36 -0000 Delivered-To: apmail-apex-dev-archive@apex.apache.org Received: (qmail 93482 invoked by uid 500); 14 Mar 2016 20:33:36 -0000 Mailing-List: contact dev-help@apex.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@apex.incubator.apache.org Delivered-To: mailing list dev@apex.incubator.apache.org Received: (qmail 93471 invoked by uid 99); 14 Mar 2016 20:33:36 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd3-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 14 Mar 2016 20:33:36 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd3-us-west.apache.org (ASF Mail Server at spamd3-us-west.apache.org) with ESMTP id 355A51800EE for ; Mon, 14 Mar 2016 20:33:36 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd3-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -3.549 X-Spam-Level: X-Spam-Status: No, score=-3.549 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, KAM_LAZY_DOMAIN_SECURITY=1, RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, RP_MATCHES_RCVD=-0.329] autolearn=disabled Received: from mx1-lw-eu.apache.org ([10.40.0.8]) by localhost (spamd3-us-west.apache.org [10.40.0.10]) (amavisd-new, port 10024) with ESMTP id qZpiUG7OGCd2 for ; Mon, 14 Mar 2016 20:33:35 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-lw-eu.apache.org (ASF Mail Server at mx1-lw-eu.apache.org) with SMTP id 4D90F5F2F2 for ; Mon, 14 Mar 2016 20:33:34 +0000 (UTC) Received: (qmail 93461 invoked by uid 99); 14 Mar 2016 20:33:33 -0000 Received: from arcas.apache.org (HELO arcas) (140.211.11.28) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 14 Mar 2016 20:33:33 +0000 Received: from arcas.apache.org (localhost [127.0.0.1]) by arcas (Postfix) with ESMTP id 6E7E02C14FB for ; Mon, 14 Mar 2016 20:33:33 +0000 (UTC) Date: Mon, 14 Mar 2016 20:33:33 +0000 (UTC) From: "ASF GitHub Bot (JIRA)" To: dev@apex.incubator.apache.org Message-ID: In-Reply-To: References: Subject: [jira] [Commented] (APEXCORE-319) Document backward compatibility guidelines MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394 [ https://issues.apache.org/jira/browse/APEXCORE-319?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15194073#comment-15194073 ] ASF GitHub Bot commented on APEXCORE-319: ----------------------------------------- Github user davidyan74 commented on a diff in the pull request: https://github.com/apache/incubator-apex-site/pull/19#discussion_r56070632 --- Diff: src/md/compatibility.md --- @@ -0,0 +1,112 @@ +#Apache Apex Compatibility + +##Purpose + +This document captures the compatibility goals of the Apache Apex project. The different types of compatibility between Apex releases that affect contributors, downstream projects, and end-users are enumerated. For each type of compatibility we: + +* describe the impact on downstream projects or end-users +* where applicable, call out the policy adopted when incompatible changes are permitted. + +Apache Apex follows [semantic versioning](http://semver.org/). Depending in the compatibility type, there may be different tools or mechanisms to ensure compatibility, for example by comparing artifacts during the build process. + +The type of change will inform the required target version number. Given a version number MAJOR.MINOR.PATCH, increment the: + +* MAJOR version when you make incompatible API changes, +* MINOR version when you add functionality in a backwards-compatible manner, and +* PATCH version when you make backwards-compatible bug fixes. --- End diff -- I think we don't need the "s" in backward-compatible > Document backward compatibility guidelines > ------------------------------------------ > > Key: APEXCORE-319 > URL: https://issues.apache.org/jira/browse/APEXCORE-319 > Project: Apache Apex Core > Issue Type: Task > Reporter: Chris Nauroth > Assignee: Thomas Weise > Labels: tlp > > QU40 > The project puts a high priority on backwards compatibility and aims to > document any incompatible changes and provide tools and documentation to help users transition to new features. > I couldn't find backwards-compatibility guidelines documented at > apex.incubator.apache.org. Example: > http://hadoop.apache.org/docs/r2.7.2/hadoop-project-dist/hadoop-common/Comp > atibility.html -- This message was sent by Atlassian JIRA (v6.3.4#6332)