Added Policy Documentation to the Repository #2114

mitchelsellers · 2018-06-12T05:07:25Z

Summary

Added updated Markdown files, and added links from the main Readme.md file to document the new policies and procedures mutually agreed upon by the Community and ESW relating to the future developments and releases for the DNN Platform.

…ation inside of the repository

ohine

Looks great! My only comment is I'd love to see the ability to upgrade production sites to RC builds as soon as possible.

tpluscode · 2018-06-12T05:24:40Z

.github/PULL_REQUEST_PROCESS.md

+* Pull request comment should contain at a minimum the following details (When creating, a default template will also prompt you for the proper information)
+--* Issue #, referenced such as “Fixes #24”
+--* Release Note: Suggested release note for the change such as “Improvement of user profile to improve performance when searching.”
+--* Testing Steps: Suggested testing steps for validation of the change


Let's take the occasion to add Testing steps to issue template and Fixes #XXX to the PR template

tpluscode · 2018-06-12T05:26:00Z

.github/PULL_REQUEST_PROCESS.md

+* Vicnec Masanas ([vmasanas](https://github.com/vmasanas))
+* Erik van Ballegoij ([erikvb](https://github.com/erikvb))
+
+An individual performing the code review should validate at a minimum the following.


Do you want to mention that tests are greatly appreciated?

How about:

Any tests related to the change have been updated

New tests covering the change are expected for areas of code already under test, and appreciated for areas of code not currently under test

bdukes · 2018-06-12T14:55:41Z

.github/PULL_REQUEST_PROCESS.md

+
+* Change should represent an entire solution for the issue at hand.  Partial requests will NOT be processed.
+* Change should have a supporting issue logged on the DNN_Platform GitHub account, documenting the issue resolved, following the procedures outlined on the [Contribute Page](CONTRIBUTING.md)
+* Exception: Security items can be addressed individually, and should be initially communicated to the [email protected] email address for coordination


This line needs to be indented, and Exception should probably be emphasized.

bdukes · 2018-06-12T14:56:38Z

.github/PULL_REQUEST_PROCESS.md

+* Change should have a supporting issue logged on the DNN_Platform GitHub account, documenting the issue resolved, following the procedures outlined on the [Contribute Page](CONTRIBUTING.md)
+* Exception: Security items can be addressed individually, and should be initially communicated to the [email protected] email address for coordination
+* Pull request comment should contain at a minimum the following details (When creating, a default template will also prompt you for the proper information)
+--* Issue #, referenced such as “Fixes #24”


These indents aren't working. To indent, just use spaces, e.g.

* Something * Something Else * And another thing

bdukes · 2018-06-12T14:57:11Z

.github/PULL_REQUEST_PROCESS.md

+* Brian Dukes ([bdukes](https://github.com/bdukes))
+* Peter Donker ([donker](https://github.com/donker)) - Community Developer Advisory Group Lead
+* Vicnec Masanas ([vmasanas](https://github.com/vmasanas))
+* Erik van Ballegoij ([erikvb](https://github.com/erikvb))


@tpluscode should be on this list, right?

@mitchelsellers can you please update this list of reviewers?

We need to add @iJungleboy

That list is current for the community side of the approvers list. I'm going to merge the PR now. As we expand the @dnnsoftware/approvers group in the future we can add more people to the docs.

bdukes · 2018-06-12T14:58:56Z

.github/PULL_REQUEST_PROCESS.md

+* Vicnec Masanas ([vmasanas](https://github.com/vmasanas))
+* Erik van Ballegoij ([erikvb](https://github.com/erikvb))
+
+An individual performing the code review should validate at a minimum the following.


How about:

Any tests related to the change have been updated

New tests covering the change are expected for areas of code already under test, and appreciated for areas of code not currently under test

bdukes · 2018-06-12T15:01:12Z

.github/VERSIONING_POLICY.md

+These releases are created primarily to contain hot-fix style improvements from prior releases.  Any bugs or security issues identified, or missing UI/UX features from a Minor/Major release might be added to a revision release.  Similar to a Minor release a Revision release will not contain any known breaking changes.
+## API Deprecation Policy
+The DNN Platform project is in a state of transition, continuing to modernize the API and work towards a transition to .NET Core.  To this point, it will be necessary for the project to remove public api's.  This will be done methodically, allowing developers to transition away from the older code with time to properly respond to change.
+Any API method to be removed will be flagged a deprecated in a release, major, minor or revision, and will be identified to be removed by a specific version.  This will be done using a C# annotation with a comment similar to the following "Deprecated in x.x.x, will be removed in y.0.0, use ____ instead".  The version number of "y" in this example must be 2 major versions ahead.  


typo: "flagged as deprecated"

bdukes · 2018-06-12T15:01:29Z

.github/VERSIONING_POLICY.md

+### Revision Releases (Ex 10.1.1, 10.1.2, 10.1.x)
+These releases are created primarily to contain hot-fix style improvements from prior releases.  Any bugs or security issues identified, or missing UI/UX features from a Minor/Major release might be added to a revision release.  Similar to a Minor release a Revision release will not contain any known breaking changes.
+## API Deprecation Policy
+The DNN Platform project is in a state of transition, continuing to modernize the API and work towards a transition to .NET Core.  To this point, it will be necessary for the project to remove public api's.  This will be done methodically, allowing developers to transition away from the older code with time to properly respond to change.


typo: change "api's" to "APIs"

mitchelsellers · 2018-06-14T23:04:44Z

I implemented the changes requested. @bdukes can you review/approve/merge?

bdukes · 2018-06-15T15:15:29Z

.github/PULL_REQUEST_PROCESS.md

+* Brian Dukes ([bdukes](https://github.com/bdukes))
+* Peter Donker ([donker](https://github.com/donker)) - Community Developer Advisory Group Lead
+* Vicnec Masanas ([vmasanas](https://github.com/vmasanas))
+* Erik van Ballegoij ([erikvb](https://github.com/erikvb))


@mitchelsellers can you please update this list of reviewers?

bdukes · 2018-06-15T15:15:53Z

.github/PULL_REQUEST_PROCESS.md

+* Brian Dukes ([bdukes](https://github.com/bdukes))
+* Peter Donker ([donker](https://github.com/donker)) - Community Developer Advisory Group Lead
+* Vicnec Masanas ([vmasanas](https://github.com/vmasanas))
+* Erik van Ballegoij ([erikvb](https://github.com/erikvb))


We need to add @iJungleboy

mitchelsellers added 9 commits June 11, 2018 22:56

Correct link on ReadMe.md to properly link to the contribution inform…

efacb00

…ation inside of the repository

Another edit to the readme links

7808193

Addition of documented Pull Request process to the project

443e039

Hyperlinked profile links

78a0890

Addition of Versioning Policy document

2776ad6

Link fix?

e0b4c5f

Fix links and reorder files

6514e40

Final documentation changes to structure

0d92114

Addition of Release Schedule document

a088a4a

mitchelsellers added the Community Legacy label used to identify community contributions label Jun 12, 2018

mitchelsellers requested review from tpluscode, ashishpd and ohine June 12, 2018 05:07

ohine approved these changes Jun 12, 2018

View reviewed changes

ohine requested a review from bdukes June 12, 2018 05:18

ohine added the Review in Progress label Jun 12, 2018

tpluscode reviewed Jun 12, 2018

View reviewed changes

bdukes requested changes Jun 12, 2018

View reviewed changes

Review changes implemented

68643df

bdukes approved these changes Jun 15, 2018

View reviewed changes

ohine removed the Review in Progress label Jun 18, 2018

ohine added this to the 9.2.1 milestone Jun 18, 2018

ohine merged commit 2350ca9 into dnnsoftware:development Jun 18, 2018

ohine modified the milestone: 9.2.1 Jun 21, 2018

Uh oh!

Added Policy Documentation to the Repository #2114

Added Policy Documentation to the Repository #2114

Uh oh!

Conversation

mitchelsellers commented Jun 12, 2018

Summary

Uh oh!

ohine left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mitchelsellers commented Jun 14, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!