From 5c79e8bb5f087e552a562d0fe4357df6fb3cce18 Mon Sep 17 00:00:00 2001 From: Daniel Valadas Date: Tue, 3 Dec 2019 19:23:18 -0500 Subject: [PATCH 01/12] Update documentation as per new branching --- CONTRIBUTING.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0370196da8d..2f9e66e90ab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,6 +8,7 @@ be extremely difficult for the core maintainers to reproduce. We want to keep it If you are new to Dnn Development, you can start by watching this video playlist which explains how to setup the required tools, your development environment and submit pull requests for modules, this repository and the Persona Bar. [How to make a pull requests playlist](https://www.youtube.com/playlist?list=PLIx1M8IdVvqZ0bnODGqJyxvONNPj5BzMP) +Please note that this playlist was recorded some time ago, if you encounter conflicting information, please rely on the most recent written documentation over what you see in those videos. * Make sure you have a [GitHub account](https://github.com/signup/free) * [Submit a ticket](https://github.com/dnnsoftware/Dnn.Platform/issues/new) for your issue, assuming one does not already exist. After review, if the pull request is accepted, we will mark the issue as resolved and assign it to a release so it can be QA'ed. @@ -28,9 +29,9 @@ If this is your first time working with Dnn:Platform. You will need to fork the ## Making Changes * Create a topic branch from where you want to base your work. - * This is usually the 'development' branch. + * This is usually the 'develop' branch. * Release branches should only be targeted in special cases and with approval from the approver group. - * To quickly create a topic branch based on development; `git checkout -b my_contribution development` + * To quickly create a topic branch based on develop; `git checkout -b my_contribution develop` * Make commits of logical units. * Check for unnecessary whitespace with `git diff --check` before committing. * When ready to publish your changes, you can with `git push -u origin my_contribution` @@ -75,7 +76,7 @@ a ticket number. ```` ## Submitting Changes -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. +Once your change is completed you will want to follow the [Pull Request Process](https://github.com/dnnsoftware/Dnn.Platform/blob/develop/.github/PULL_REQUEST_PROCESS.md) to submit your changes for review & inclusion in the next release. # Additional Resources From 9186fdf6732824d45518cc972e1dc517e28f0fe2 Mon Sep 17 00:00:00 2001 From: Daniel Valadas Date: Tue, 3 Dec 2019 19:25:03 -0500 Subject: [PATCH 02/12] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ca7e6aa568c..5aa37b6995a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![Build status](https://dotnet.visualstudio.com/DNN/_apis/build/status/DNN%20%5BCI%5D?branchName=development)](https://dotnet.visualstudio.com/DNN/_build/latest?definitionId=27&branchName=development) +[![Build status](https://dotnet.visualstudio.com/DNN/_apis/build/status/DNN%20%5BCI%5D?branchName=develop)](https://dotnet.visualstudio.com/DNN/_build/latest?definitionId=27&branchName=develop) ![DNN Platform At A Glance](dnnplatform.png) From 328d4c8c980ec0930cc2084aaa620ecd4416e3e0 Mon Sep 17 00:00:00 2001 From: Daniel Valadas Date: Tue, 3 Dec 2019 19:27:35 -0500 Subject: [PATCH 03/12] Update gitversion.yml --- gitversion.yml | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/gitversion.yml b/gitversion.yml index 7075ad52db8..36476b2a3b5 100644 --- a/gitversion.yml +++ b/gitversion.yml @@ -3,9 +3,20 @@ commit-date-format: 'yyyyMMdd' assembly-file-versioning-format: '{Major}.{Minor}.{Patch}.{CommitsSinceVersionSource}' mode: ContinuousDeployment branches: + + future: + regex: future?[/-] + tag: 'alpha' + increment: Major + source-branches: [] development: regex: development tag: 'alpha' + increment: Major + source-branches: [] + develop: + regex: develop + tag: 'alpha' increment: Patch is-mainline: true source-branches: [] @@ -33,4 +44,4 @@ branches: increment: Patch prevent-increment-of-merged-branch-version: false is-release-branch: false - source-branches: [] \ No newline at end of file + source-branches: [] From 5de03bdeb4d19f436f65b6927f0503a85e0f4f35 Mon Sep 17 00:00:00 2001 From: Daniel Valadas Date: Tue, 3 Dec 2019 19:29:10 -0500 Subject: [PATCH 04/12] Update bug-report.md --- .github/ISSUE_TEMPLATE/bug-report.md | 42 +++++++++++++--------------- 1 file changed, 20 insertions(+), 22 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index d74fd233115..195b8bc9baa 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -1,53 +1,51 @@ --- name: Bug Report -about: Create a report to help us improve +about: Report a bug in DNN Platform --- - + If you need community support or would like to solicit a Request for Comments (RFC), please post to the DNN Community forums at https://dnncommunity.org/forums for now. In the future, we are planning to implement a more robust solution for cultivating new ideas and nuturing these from concept to creation. We will update this template when this solution is generally available. In the meantime, we appreciate your patience as we endeavor to streamline our GitHub focus and efforts. + + Please read the CONTRIBUTING guidelines at https://github.com/dnnsoftware/Dnn.Platform/blob/development/CONTRIBUTING.md prior to submitting an issue. + Any potential security issues SHOULD NOT be posted on GitHub. Instead, please send an email to security@dnnsoftware.com. +--> ## Description of bug -Provide a clear and concise description of what the bug is. +Provide a clear and concise description of the bug. ## Steps to reproduce -List the steps to reproduce the behavior: +List the precise steps to reproduce the bug: 1. Go to '...' 2. Click on '....' -3. Scroll down to '....' +3. Scroll to '....' 4. See error -## Current result -Explain what the current result is. +## Current behavior +Explain the current behavior. -## Expected result -Provide a clear and concise description of what you expected to happen. +## Expected behavior +Provide a clear and concise description of the expected behavior. ## Screenshots -If applicable, provide screenshots to help explain your problem. +If applicable, provide screenshots to help explain the bug. -## Error log -Paste the error log that is related to this issue. +## Error information +Provide any error information (console errors, error logs, etc.) related to this bug. ## Additional context -Add any other context about the bug that may be helpful for resolution. +Provide any additional context that may be helpful in understanding and/or resolving the bug. ## Affected version - * [ ] 10.0.0 alpha build -* [ ] 9.4.3 alpha build -* [ ] 9.4.2 latest supported release +* [ ] 9.5.0 alpha build +* [ ] 9.4.3 latest supported release ## Affected browser - * [ ] Chrome * [ ] Firefox * [ ] Safari From 66d9d1a35c4de331063d2790636634b9cd133078 Mon Sep 17 00:00:00 2001 From: Daniel Valadas Date: Tue, 3 Dec 2019 19:29:54 -0500 Subject: [PATCH 05/12] Delete feature-request.md --- .github/ISSUE_TEMPLATE/feature-request.md | 35 ----------------------- 1 file changed, 35 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index 7a4ab86a061..00000000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: Feature Request -about: Suggest an idea for this project ---- - - -## Description of problem -Is your feature request related to a problem? Provide a clear and concise description of the problem. - -## Description of solution -Provide a clear and concise description of what you want to happen. - -## Description of alternatives considered -Provide a clear and concise description of any alternative solutions or features you have considered. - -## Screenshots -If applicable, provide screenshots to help explain your problem and/or feature. - -## Additional context -Add any other context about the feature that may be helpful with implementation. - -## Affected browser - - -* [ ] Chrome -* [ ] Firefox -* [ ] Safari -* [ ] Internet Explorer -* [ ] Edge From 935241a113328d783810d1d4ee45acbf28a7b817 Mon Sep 17 00:00:00 2001 From: Daniel Valadas Date: Tue, 3 Dec 2019 19:30:09 -0500 Subject: [PATCH 06/12] Delete help-and-other-questions.md --- .../help-and-other-questions.md | 55 ------------------- 1 file changed, 55 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/help-and-other-questions.md diff --git a/.github/ISSUE_TEMPLATE/help-and-other-questions.md b/.github/ISSUE_TEMPLATE/help-and-other-questions.md deleted file mode 100644 index f49ab75f670..00000000000 --- a/.github/ISSUE_TEMPLATE/help-and-other-questions.md +++ /dev/null @@ -1,55 +0,0 @@ - - -## Summary -Summarize your question in one sentence. - -## Extended description -Provide a more detailed description of your question. - -## Steps to reproduce (if necessary) -List the steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -## Current result (if necessary) -Explain what the current result is. - -## Expected result (if necessary) -Provide a clear and concise description of what you expected to happen. - -## Screenshots (if necessary) -If applicable, provide screenshots to help explain your problem. - -## Error log (if necessary) -Paste the related error log. - -## Additional context -Add any other context that may be helpful. - -## Affected version - - -* [ ] 10.0.0 alpha build -* [ ] 9.4.3 alpha build -* [ ] 9.4.2 latest supported release - -## Affected browser - - -* [ ] Chrome -* [ ] Firefox -* [ ] Safari -* [ ] Internet Explorer -* [ ] Edge From 2d7376621e5dac5d60d7cd523531a8098f3a4f9e Mon Sep 17 00:00:00 2001 From: Daniel Valadas Date: Tue, 3 Dec 2019 19:30:23 -0500 Subject: [PATCH 07/12] Delete request-for-comments.md --- .../ISSUE_TEMPLATE/request-for-comments.md | 27 ------------------- 1 file changed, 27 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/request-for-comments.md diff --git a/.github/ISSUE_TEMPLATE/request-for-comments.md b/.github/ISSUE_TEMPLATE/request-for-comments.md deleted file mode 100644 index 9bea211e18d..00000000000 --- a/.github/ISSUE_TEMPLATE/request-for-comments.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -name: Request for Comments -about: Start a discussion around a feature, enhancement, or other change to DNN.Platform ---- - - - -## Description of Problem -Summarization of the solution requesting commentary. - -## Proposed Solution Option 1 -A proposed solution to the problem - -## Proposed Solution Option 2 (If Needed, repeat for more) -Another proposed solution to the problem - -## Alternatives Researched -Documentation of any other items researched for resolution. - -## Affected version - -* [ ] 10.0.0 alpha build -* [ ] 9.4.3 alpha build -* [ ] 9.4.2 latest supported release From d55c667423735cceba2bb3b28e9f072e58dd3f4c Mon Sep 17 00:00:00 2001 From: Daniel Valadas Date: Tue, 3 Dec 2019 19:30:46 -0500 Subject: [PATCH 08/12] Create enhancement-request.md --- .github/ISSUE_TEMPLATE/enhancement-request.md | 35 +++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/enhancement-request.md diff --git a/.github/ISSUE_TEMPLATE/enhancement-request.md b/.github/ISSUE_TEMPLATE/enhancement-request.md new file mode 100644 index 00000000000..3b7c9063528 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement-request.md @@ -0,0 +1,35 @@ +--- +name: Enhancement Request +about: Request an enhancement to DNN Platform +--- + +## Description of problem +Is your enhancement request related to a problem? Provide a clear and concise description of the problem. + +## Description of solution +Provide a clear and concise description of the solution. + +## Description of alternatives considered +Provide a clear and concise description of any alternative solutions considered. + +## Screenshots +If applicable, provide screenshots to help explain the problem and/or enhancement. + +## Additional context +Add any other context about the enhancement that may be helpful with implementation. + +## Affected browser + +* [ ] Chrome +* [ ] Firefox +* [ ] Safari +* [ ] Internet Explorer +* [ ] Edge From 73d21ece0c82c9ccea424623095aab50c851ceab Mon Sep 17 00:00:00 2001 From: Daniel Valadas Date: Tue, 3 Dec 2019 19:52:57 -0500 Subject: [PATCH 09/12] Update BUILD.md --- .github/BUILD.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/BUILD.md b/.github/BUILD.md index b4dd1cc3c8a..ec64d03c7b0 100644 --- a/.github/BUILD.md +++ b/.github/BUILD.md @@ -7,7 +7,8 @@ If you do need to build the entire solution and the distribution packages, you n * [CKEditorProvider](https://github.com/DNN-Connect/CKEditorProvider) - The default HTML Editor Provider * [CDF](https://github.com/dnnsoftware/ClientDependency) - The Dnn Client Dependency Framework -Also, we currently maintain two branches, the development branch is the next major release and we also maintain a release/x.x.x branch that allows doing bug fixes on the current major version. +## Understanding the branches +Our default branch is called **develop**, this is the branch most pull requests should target in order to be merged into the very next release (bug fixes, minor improvements that are not breaking changes). If you know your change will be a breaking change or more risky, then you should submit it targeting the **future/xx** branch (where xx is the next major release). **release/x.x.x** branches are temporary, they get created at code-freeze to built an alpha release for the testing team, when initial testing is done, we publish one or more release candiate versions (RC1, RC2) as needed until we find the version stable for release, at which point we release that new version and close the release/x.x.x branch. The only pull requests that will be accepted for release/x.x.x branches are for regression issues (the problem was introduced in this very version) or showstopper issues (can't use Dnn with this bug in). To prevent issues with long paths in some build scripts, fork this repository in a short named folder on the root of any drive such as `c:\dnnsrc\` if you fork to a long path such as `c:\users\username\documents\dnn\source\` you may encounter long path issues. @@ -34,4 +35,4 @@ Also, the build scripts should leave you with 0 tracked modified files in git. If a build fails midway and you have tracked artifacts, you can simply run: `git reset --hard` and/or `git clean -dxf` in order to come back to a clean state. -If you encounter PowerShell security issues, please read [Cake - PowerShell Security](https://cakebuild.net/docs/tutorials/powershell-security) \ No newline at end of file +If you encounter PowerShell security issues, please read [Cake - PowerShell Security](https://cakebuild.net/docs/tutorials/powershell-security) From 090561fb8f0d3787b29da9c26cefcbae2104889c Mon Sep 17 00:00:00 2001 From: Daniel Valadas Date: Tue, 3 Dec 2019 20:00:23 -0500 Subject: [PATCH 10/12] Update PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c64fcdd7015..e4d74d0b48c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,16 +1,16 @@ + ## Summary From a06fcaafe92d3efcfd3c8a0ea081e338cb1db7d1 Mon Sep 17 00:00:00 2001 From: Daniel Valadas Date: Tue, 3 Dec 2019 20:07:31 -0500 Subject: [PATCH 11/12] Update RELEASE_SCHEDULE.md --- .github/RELEASE_SCHEDULE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/RELEASE_SCHEDULE.md b/.github/RELEASE_SCHEDULE.md index b1e77ba216f..45e85715a45 100644 --- a/.github/RELEASE_SCHEDULE.md +++ b/.github/RELEASE_SCHEDULE.md @@ -2,7 +2,7 @@ To ensure adequate time for release planning by the community, partners, and vendors a specific release process will be followed for all releases. ## Release Candidates -For a period of two-weeks (Minor & Revision) or four-weeks (Major) before any release, a Release Candidate (RC) version will be made available to the public. At present these release candidates will be for testing only. After version 10.x efforts will be made to support upgrading from RC to Production releases. +For a period of one week (Revision), two weeks (Minor) or four-weeks (Major) before any release, a Release Candidate (RC) version will be made available to the public. At present these release candidates will be for testing only. After version 10.x efforts will be made to support upgrading from RC to Production releases. The goal of these release candidates is to give the community time to adjust their existing environments for any breaking changes, as well as to identify any issues with the changes. If necessary, changes will be incorporated an additional RC release could be made if significant problems are identified. If a revised Release Candidate is necessary the Production Release schedule will be impacted. The exact impact will vary on a case-by-case basis depending on the nature of the issue(s) identified during RC review, however, will be clearly communicated during the release. From e211fbb67dc5bc8fb2db1a1cc13863101427a31c Mon Sep 17 00:00:00 2001 From: Daniel Valadas Date: Tue, 3 Dec 2019 20:09:10 -0500 Subject: [PATCH 12/12] Create stale.yml --- .github/stale.yml | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 .github/stale.yml diff --git a/.github/stale.yml b/.github/stale.yml new file mode 100644 index 00000000000..e3318dc622d --- /dev/null +++ b/.github/stale.yml @@ -0,0 +1,34 @@ +# Number of days of inactivity before an issue becomes stale +daysUntilStale: 90 +# Number of days of inactivity before a stale issue is closed +daysUntilClose: 14 +# Issues with these labels will never be considered stale +exemptLabels: + - pinned + - security + - bug + - noteworthy + - pull request submitted +# Label to use when marking an issue as stale +staleLabel: stale +# Comment to post when marking an issue as stale. Set to `false` to disable +markComment: > + We have detected this issue has not had any activity during the last 90 + days. That could mean this issue is no longer relevant and/or nobody has + found the necessary time to address the issue. We are trying to keep the + list of open issues limited to those issues that are relevant to the + majority and to close the ones that have become 'stale' (inactive). If no + further activity is detected within the next 14 days, the issue will be + closed automatically. + + If new comments are are posted and/or a solution (pull request) is + submitted for review that references this issue, the issue will not be + closed. Closed issues can be reopened at any time in the future. Please + remember those participating in this open source project are volunteers + trying to help others and creating a better DNN Platform for all. Thank + you for your continued involvement and contributions! +# Comment to post when closing a stale issue. Set to `false` to disable +closeComment: > + This issue has been closed automatically due to inactivity (as mentioned + 14 days ago). Feel free to re-open the issue if you believe it is still + relevant.