Add a PendingRelease notes file (#2723)

Also update the CONTRIBUTING file with a description of how to work
with this file.

Signed-off-by: Wido den Hollander <wido@widodh.nl>
This commit is contained in:
Wido den Hollander 2018-07-03 21:17:41 +02:00 committed by dahn
parent d0d3895c39
commit 36f1900281
2 changed files with 50 additions and 0 deletions

View File

@ -24,6 +24,15 @@ Send a PR(steps below) to get it into master (2x LGTM applies).
PR will only be merged when master is open, will be held otherwise until master is open again.
No back porting / cherry-picking features to existing branches!
PendingReleaseNotes file
------------------------
When developing a new feature or making a (major) change to a existing feature you are encouraged to append this to the PendingReleaseNotes file so that the Release Manager can
use this file as a source of information when compiling the Release Notes for a new release.
When adding information to the PendingReleaseNotes file make sure that you write a good and understandable description of the new feature or change which you have developed.
Updating the PendingReleaseNotes file is preferably a part of the original Pull Request, but that is up to the developers' discretion.
Fork the code
-------------

41
PendingReleaseNotes Normal file
View File

@ -0,0 +1,41 @@
# 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.
#
#
# PENDING RELEASE NOTES
#
# WHEN DEVELOPING A NEW FEATURE OR MAKING A (MAJOR) CHANGE TO
# AN EXISTING FEATURE DEVELOPERS ARE ENCOURAGED TO UPDATED THIS
# FILE WITH THE CHANGES THEY MADE.
#
# THE RELEASE MANAGER CAN USE THIS FILE AS A SOURCE OF INFORMATION
# WHEN COMPILING THE RELEASE NOTES FOR A NEW RELEASE.
#
# THIS FILE IS TRUNCATED AFTER THE RELEASE OF THE NEW VERSION
#
#
example.ver.1 > example.ver.2:
* VirtualRouters are now deployed with the latest version of ExampleLinux
and wil also use a new MyFirstDHCPServer instead of dnsmasq to provide
faster and more robust deployment of new Instances
* ISOs are no longer supported and will be replaced by 2.88MB Floppy Drives
which can now be attached to Instances. This is to prevent the Secondary
Storage to grow to enormous sizes as Linux Distributions keep growing in
size while a stripped down Linux should fit on a 2.88MB floppy.