Repository: incubator-predictionio Updated Branches: refs/heads/livedoc 55ce7b87d -> 8e96d1b59
[PIO-66] Document JIRA processes Closes #417 Project: http://git-wip-us.apache.org/repos/asf/incubator-predictionio/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-predictionio/commit/8e96d1b5 Tree: http://git-wip-us.apache.org/repos/asf/incubator-predictionio/tree/8e96d1b5 Diff: http://git-wip-us.apache.org/repos/asf/incubator-predictionio/diff/8e96d1b5 Branch: refs/heads/livedoc Commit: 8e96d1b59c90b0834cf55ce33ba8224dbb7e19f8 Parents: 55ce7b8 Author: shimamoto <[email protected]> Authored: Thu Aug 3 11:42:41 2017 -0700 Committer: Donald Szeto <[email protected]> Committed: Thu Aug 3 11:42:41 2017 -0700 ---------------------------------------------------------------------- docs/manual/data/nav/main.yml | 3 ++ .../source/community/contribute-code.html.md | 30 ++++++++++++---- docs/manual/source/resources/release.html.md | 38 ++++++++++++++++++++ 3 files changed, 65 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/8e96d1b5/docs/manual/data/nav/main.yml ---------------------------------------------------------------------- diff --git a/docs/manual/data/nav/main.yml b/docs/manual/data/nav/main.yml index 245fbaf..33c05eb 100644 --- a/docs/manual/data/nav/main.yml +++ b/docs/manual/data/nav/main.yml @@ -319,6 +319,9 @@ root: url: '#' children: - + body: 'Release Cadence' + url: '/resources/release/' + - body: 'Developing Engines with IntelliJ IDEA' url: '/resources/intellij/' - http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/8e96d1b5/docs/manual/source/community/contribute-code.html.md ---------------------------------------------------------------------- diff --git a/docs/manual/source/community/contribute-code.html.md b/docs/manual/source/community/contribute-code.html.md index f1c1810..d295427 100644 --- a/docs/manual/source/community/contribute-code.html.md +++ b/docs/manual/source/community/contribute-code.html.md @@ -52,6 +52,8 @@ bug fixes will follow a different path. ## How to Add / Propose a New Feature +Before adding new features into JIRA, please check that the feature does not currently exist in JIRA. + 1. To propose a new feature, simply [subscribe](mailto:[email protected]) and post your proposal to [Apache PredictionIO (incubating) Development Mailing List] @@ -64,6 +66,26 @@ bug fixes will follow a different path. (incubating) Development Mailing List as primary mode of communication. You never know if someone else has a better idea. ;) +### Adding ticket to JIRA + +1. Add a descriptive Summary and a detailed description +2. Set Issue Type to Bug, Improvement, New Feature, Test or Wish +3. Set Priority to Blocker, Critical, Major, Minor or Trivial +4. Fill out Affects Version with the version of PredictionIO you are currently using +5. Fill out Environment if needed for description of your bug / feature +6. Please leave other fields blank + +### Triaging JIRA + +Tickets will be triaged by PredictionIO committers. + +- **Target Version**: Either a particular version or `Future` if to be done later + + Once a fix has been committed, the Fix Version will filled in with the appropriate release + +- **Component**: Each ticket will be annotated with one or more of the following Components + + **Core**: affects the main code branch / will be part of a release + + **Documentation**: affects the documents / will be pushed to livedoc branch + + **Templates**: affects one of the separate github repositories for a template ## How to Issue a Pull Request @@ -159,10 +181,6 @@ layer for event store and metadata store. Source code for http://predictionio.incubator.apache.org site, and any other documentation support files. -### engines - -Obsolete built-in engines. To be removed. - ### examples Complete code examples showing Apache PredictionIO (incubating)'s application. @@ -171,9 +189,9 @@ Complete code examples showing Apache PredictionIO (incubating)'s application. Embedded SBT (Simple Build Tool) launcher. -### templates +### storage -Starting point of building your custom engine. +Storage implementations. ### tools http://git-wip-us.apache.org/repos/asf/incubator-predictionio/blob/8e96d1b5/docs/manual/source/resources/release.html.md ---------------------------------------------------------------------- diff --git a/docs/manual/source/resources/release.html.md b/docs/manual/source/resources/release.html.md new file mode 100644 index 0000000..87f8680 --- /dev/null +++ b/docs/manual/source/resources/release.html.md @@ -0,0 +1,38 @@ +--- +title: Release Cadence +--- + +<!-- +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> + +## Versions + +Each PIO release will be versioned: `<MAJOR>`.`<FEATURE>`.`<MAINTENANCE>` + +- **MAJOR**: Major releases are not on any particular cadence. Major releases are likely to be + stable over a long period (one year or more) +- **FEATURE**: We are targeting new feature releases every two months and will include new + features, improvements and bug fixes +- **MAINTENANCE**: This is reserved for urgent bug fixes on the current release + +## Release Cadence + +Feature releases will occur every two months. Maintenance releases will be ad-hoc, as needed. + +- At the beginning of each release, committers nominate features for the upcoming release +- At end of week, share JIRA link with dev user group to invite comments on the list +- Committers modify the target list as necessary after comments are integrated and assign them to devs
