Skip to content

Commit c2eaaee

Browse files
mitchelsellersbdukes
authored andcommitted
Updated Project documentation (#3057)
* Updated Documentation * Corrected typo Co-Authored-By: Brian Dukes <bdukes@engagesoftware.com>
1 parent 866d737 commit c2eaaee

4 files changed

Lines changed: 23 additions & 20 deletions

File tree

.github/PULL_REQUEST_PROCESS.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ The following items must all be true prior to a pull request being submitted to
2222
## Code Review Process
2323
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.
2424

25+
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.
26+
2527
### Designated Approvers
2628
At the current time the following community members are designated approvers.
2729

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

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

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

5757
> This **_MUST NOT_** be done by the submitter of the Pull Request for ANY reason!
5858
59-
### Exception for Build Process Pull Requests
60-
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.
59+
### Execption for Build Process Pull Requests
60+
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.
6161

6262
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.
6363

.github/VERSIONING_POLICY.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# DNN Platform Versioning and Deprecation Policies
22
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.
33

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

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

1212
### Minor Releases (Ex 10.1, 10.2, 10.x)
13-
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.
13+
A minor might contain smaller new features and enhancements, however, best efforts will be taken to minimize breaking changes.
1414

1515
### Revision Releases (Ex 10.1.1, 10.1.2, 10.1.x)
1616
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.
1717

1818
## API Deprecation Policy
1919
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.
20+
2021
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.
22+
2123
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.
2224
> Example: [Obsolete("Deprecated in DotNetNuke 7.0. This function has been replaced by AddUserRole with additional params. Scheduled removal in v10.0.0.")]
2325

CONTRIBUTING.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ If this is your first time working with Dnn:Platform. You will need to fork the
2828
## Making Changes
2929

3030
* Create a topic branch from where you want to base your work.
31-
* This is usually the 'development' branch.
31+
* This is usually the 'development' branch.
3232
* Release branches should only be targeted in special cases and with approval from the approver group.
3333
* To quickly create a topic branch based on development; `git checkout -b my_contribution development`
3434
* Make commits of logical units.
@@ -74,7 +74,8 @@ a ticket number.
7474
The first line is a real-life imperative statement with '(doc)' in place of what would have been the ticket number in a non-documentation related commit. The body describes the nature of the new documentation or comments added.
7575
````
7676

77-
## Submitting Changes
77+
# Submitting & Process of Pull Requests
78+
7879
Once your change is completed you will want to follow the [Pull Request Process](https://github.com/dnnsoftware/Dnn.Platform/blob/development/.github/PULL_REQUEST_PROCESS.md) to submit your changes for review & inclusion in the next release.
7980

8081
# Additional Resources

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,26 +24,25 @@ In addition to robust content management, the free, open source DNN Platform inc
2424

2525
## Quick Links
2626

27-
* [Contribute](CONTRIBUTING.md)
28-
* [Build](.github/BUILD.md)
29-
* [Pull Request Procedures](.github/PULL_REQUEST_PROCESS.md)
30-
* [Versioning Policy](.github/VERSIONING_POLICY.md)
27+
* [Documentation] (https://www.dnndocs.com/)
3128
* [Release Schedule](.github/RELEASE_SCHEDULE.md)
3229
* [DNN Digest](http://www.dnnsoftware.com/community/participate/subscribe-to-dnn-digest)
33-
* [Questions & Answers](http://answers.dnnsoftware.com/)
34-
* [Showcase](http://www.dnnsoftware.com/community/participate/community-showcase)
35-
* [Discussion Forums](http://forums.dnnsoftware.com/)
30+
* [Discussion Forums](https://dnncommunity.org/forums)
31+
* [Community Showcase](https://dnncommunity.org/Showcase)
3632
* [Video Library](http://www.dnnsoftware.com/videos)
37-
* [News](http://www.dnnsoftware.com/About/In-The-News/Press-Releases)
38-
* [Community Blogs](http://www.dnnsoftware.com/community-blog)
33+
* [Community Blogs](https://dnncommunity.org/blogs)
3934
* [DNN on Facebook](http://www.facebook.com/DNNsoftware)
4035
* [DNN on Twitter](http://www.Twitter.com/DNN)
4136
* [DNN Store](http://store.dnnsoftware.com/)
4237

43-
## How to Contribute
38+
## Contributing to DNN Platform
39+
40+
We encourage contributions of all forms, including code changes, testing, bug reports or otherwise. The following resources outline detailed contribution procedures.
4441

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

4847
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.
4948

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

5655
We monitor code quality of the DNN Platform using [NDepend](https://www.ndepend.com).
56+
5757
![NDepend](.github/images/PoweredByNDepend.png)

0 commit comments

Comments
 (0)