Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates documentation as per the branch reorganization #3368

Merged
merged 12 commits into from
Dec 5, 2019
5 changes: 3 additions & 2 deletions .github/BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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)
If you encounter PowerShell security issues, please read [Cake - PowerShell Security](https://cakebuild.net/docs/tutorials/powershell-security)
42 changes: 20 additions & 22 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,51 @@
---
name: Bug Report
about: Create a report to help us improve
about: Report a bug in DNN Platform
---

<!--
Please read contribution guideline first: https://github.com/dnnsoftware/Dnn.Platform/blob/development/CONTRIBUTING.md
Any potential security issues should be sent to security@dnnsoftware.com, rather than posted on GitHub
-->
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
<!--
Please add X in at least one of the boxes as appropriate. In order for an issue to be accepted, a developer needs to be able to reproduce the issue on a currently supported version. If you are looking for a workaround for an issue with an older version, please visit the forums at https://dnncommunity.org/forums
-->

* [ ] 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
<!--
Check all that apply and add more if necessary.
If possible, please also specify exact versions and mention the operating system
Check all that apply, and add more if necessary. As appropriate, please specify the exact version(s) of the browser and operating system.
-->

* [ ] Chrome
* [ ] Firefox
* [ ] Safari
Expand Down
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: Enhancement Request
about: Request an enhancement to 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 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
<!--
Check all that apply, and add more if necessary. As appropriate, please specify the exact version(s) of the browser and operating system.
-->
* [ ] Chrome
* [ ] Firefox
* [ ] Safari
* [ ] Internet Explorer
* [ ] Edge
35 changes: 0 additions & 35 deletions .github/ISSUE_TEMPLATE/feature-request.md

This file was deleted.

55 changes: 0 additions & 55 deletions .github/ISSUE_TEMPLATE/help-and-other-questions.md

This file was deleted.

27 changes: 0 additions & 27 deletions .github/ISSUE_TEMPLATE/request-for-comments.md

This file was deleted.

8 changes: 4 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
<!--
Please read contribution guideline first: https://github.com/dnnsoftware/Dnn.Platform/blob/development/CONTRIBUTING.md
Please read contribution guideline first: https://github.com/dnnsoftware/Dnn.Platform/blob/develop/CONTRIBUTING.md
-->

<!--
Please make sure that there is a correcponding issue created and reference it in the PR by writing
Please make sure that there is a corresponding issue created and reference it in the PR by writing
`Fixes #123` or `Closes #123`.
A PR without an accompanying issue will be accepted and merged on a very rare occasion
-->


## Summary
<!--
Please describe the code changes as you see fit so that the reviewers have an easier task understanding what changed and why.

Any new unit tests will be highly appreciated.
New unit tests will be highly appreciated.
-->
2 changes: 1 addition & 1 deletion .github/RELEASE_SCHEDULE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
34 changes: 34 additions & 0 deletions .github/stale.yml
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 4 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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`
Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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)

Expand Down
13 changes: 12 additions & 1 deletion gitversion.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: []
Expand Down Expand Up @@ -33,4 +44,4 @@ branches:
increment: Patch
prevent-increment-of-merged-branch-version: false
is-release-branch: false
source-branches: []
source-branches: []