Skip to content

Commit

Permalink
Updated Project documentation (dnnsoftware#3057)
Browse files Browse the repository at this point in the history
* Updated Documentation

* Corrected typo

Co-Authored-By: Brian Dukes <bdukes@engagesoftware.com>
  • Loading branch information
2 people authored and DnnSoftwarePersian committed May 17, 2020
1 parent 68abc4c commit f996b99
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 17 deletions.
8 changes: 4 additions & 4 deletions .github/PULL_REQUEST_PROCESS.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ The following items must all be true prior to a pull request being submitted to
## Code Review Process
Community review of submitted pull requests is encouraged, and all pull requests must be reviewed by at least **two (2)** designated approvers before the change can be approved. Once approved by two unique designated approvers, the change can be merged. An approver should NEVER merge their own change, even with two supporting approvals.

The DNN Platform project strives to review and comment on incoming pull requests in a timely fashion, however, it may be necessary at times to hold incoming pull requests for a period of time during releases or other administrative processes.

### Designated Approvers
At the current time the following community members are designated approvers.

Expand All @@ -31,8 +33,6 @@ At the current time the following community members are designated approvers.
* Peter Donker ([donker](https://github.com/donker)) - Community Developer Advisory Group Lead
* Daniel Valadas ([valadas](https://github.com/valadas))
* Matt Rutledge ([mtrutledge](https://github.com/mtrutledge))
* Vicenç Masanas ([vmasanas](https://github.com/vmasanas))
* Erik van Ballegoij ([erikvb](https://github.com/erikvb))

Additionally, the following individuals from ESW/DNN Corp are approved reviewers.

Expand All @@ -56,8 +56,8 @@ Once a pull request has been reviewed by two designated approvers it may be merg

> This **_MUST NOT_** be done by the submitter of the Pull Request for ANY reason!
### Exception for Build Process Pull Requests
A special exception has been granted to reduce the number of Designed Approval reviews to 1 for all pull requests related to Build Support when incrementing versions in preparation of a release, or reconfiguration of the environment for the next version.
### Execption for Build Process Pull Requests
A special exception has been granted to reduce the number of Designed Approval reviews to 1 for all pull requests related to Build Support when incrementing versions in prepration of a release, adjustments of build processes, or reconfiguration of the environment for the next version.

Additionally a special exception has been granted to merge pull requests created by the Designated Approvers for the purposes of keeping release branches in sync when the pull request ONLY moves previously approved changes. Such as moving bug fixes from a minor release into the next major release, or otherwise.

Expand Down
6 changes: 4 additions & 2 deletions .github/VERSIONING_POLICY.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# DNN Platform Versioning and Deprecation Policies
The DNN Platform follows a semantic versioning process for releases, in a manner to better communicate expectations of releases and their potential impacts to users of the platform.

##Semantic Versioning
## Semantic Versioning
The DNN Community adopted the current semantic version policy in July of 2018. Releases before this date may follow different standards.

### Major Releases (Ex 10.0.0)
Expand All @@ -10,14 +10,16 @@ A major release is as the name implies, a release with major changes. These cha
Major releases are also the time that platform requirements might be changed, such as requiring a new edition of SQL Server or otherwise.

### Minor Releases (Ex 10.1, 10.2, 10.x)
A minor might contain smaller new features and enhancements, but will not introduce any breaking API changes, nor will it change the requirements of the hosting environment or platform to run the application.
A minor might contain smaller new features and enhancements, however, best efforts will be taken to minimize breaking changes.

### 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.

Any API method to be removed will be flagged as 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. Scheduled for removal in vy.0.0, use ____ instead". The version number of "y" in this example must be 2 major versions ahead.

Therefore, an API marked as Deprecated in 9.2.1 can only be removed in version 11.0. Additionally, methods marked for removal in a version will GUARANTEED be removed in that revision.
> Example: [Obsolete("Deprecated in DotNetNuke 7.0. This function has been replaced by AddUserRole with additional params. Scheduled removal in v10.0.0.")]
Expand Down
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,25 +24,25 @@ In addition to robust content management, the free, open source DNN Platform inc

## Quick Links

* [Contribute](CONTRIBUTING.md)
* [Pull Request Procedures](.github/PULL_REQUEST_PROCESS.md)
* [Versioning Policy](.github/VERSIONING_POLICY.md)
* [Documentation] (https://www.dnndocs.com/)
* [Release Schedule](.github/RELEASE_SCHEDULE.md)
* [DNN Digest](http://www.dnnsoftware.com/community/participate/subscribe-to-dnn-digest)
* [Questions & Answers](http://answers.dnnsoftware.com/)
* [Showcase](http://www.dnnsoftware.com/community/participate/community-showcase)
* [Discussion Forums](http://forums.dnnsoftware.com/)
* [Discussion Forums](https://dnncommunity.org/forums)
* [Community Showcase](https://dnncommunity.org/Showcase)
* [Video Library](http://www.dnnsoftware.com/videos)
* [News](http://www.dnnsoftware.com/About/In-The-News/Press-Releases)
* [Community Blogs](http://www.dnnsoftware.com/community-blog)
* [Community Blogs](https://dnncommunity.org/blogs)
* [DNN on Facebook](http://www.facebook.com/DNNsoftware)
* [DNN on Twitter](http://www.Twitter.com/DNN)
* [DNN Store](http://store.dnnsoftware.com/)

## How to Contribute
## Contributing to DNN Platform

We encourage contributions of all forms, including code changes, testing, bug reports or otherwise. The following resources outline detailed contribution procedures.

We encourage everyone to contribute.
All the details on contributing with Git and on our working methods can be found on the [Contribute Page](CONTRIBUTING.md)
* [Contributing to DNN Platform](CONTRIBUTING.md)
* [Pull Request Procedures](.github/PULL_REQUEST_PROCESS.md)
* [Versioning Policy](.github/VERSIONING_POLICY.md)
* [Build Process Documentation](.github/BUILD.md)

In addition, since DNN is part of the .NET Foundation, we require our contributors to abide by their [Code of Conduct](https://www.dotnetfoundation.org/code-of-conduct) rules and requirements also.

Expand All @@ -53,4 +53,5 @@ This project is supported by the [.NET Foundation](https://dotnetfoundation.org)
## NDepend

We monitor code quality of the DNN Platform using [NDepend](https://www.ndepend.com).

![NDepend](.github/images/PoweredByNDepend.png)

0 comments on commit f996b99

Please sign in to comment.