apex-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (APEXCORE-319) Document backward compatibility guidelines
Date Mon, 14 Mar 2016 20:33:33 GMT

    [ 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)

Mime
View raw message