Skip to content

Commit

Permalink
Initial work on Winter rebrand for 1.0 branch
Browse files Browse the repository at this point in the history
  • Loading branch information
LukeTowers committed Mar 6, 2021
1 parent cb06f59 commit 7d80b77
Show file tree
Hide file tree
Showing 298 changed files with 775 additions and 781 deletions.
54 changes: 27 additions & 27 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
# Contributing to OctoberCMS
# Contributing to Winter CMS

Thank you for your interest in contributing to the OctoberCMS project. We appreciate any assistance that community members and users of OctoberCMS are willing to provide. You can contribute to the project in several different ways:
Thank you for your interest in contributing to the Winter CMS project. We appreciate any assistance that community members and users of Winter CMS are willing to provide. You can contribute to the project in several different ways:

- [Reporting a Security Vulnerability](#reporting-a-security-vulnerability)
- [Reporting an issue with OctoberCMS](#reporting-an-issue-with-octobercms)
- [Reporting an issue with an OctoberCMS plugin](#reporting-an-issue-with-an-octobercms-plugin)
- [Reporting an issue with Winter CMS](#reporting-an-issue-with-octobercms)
- [Reporting an issue with an Winter CMS plugin](#reporting-an-issue-with-an-octobercms-plugin)
- [Making a Feature Request](#making-a-feature-request)
- [Making a Pull Request](#making-a-pull-request)
- [Testing Pull Requests](#testing-a-pull-request)

## Reporting a Security Vulnerability

Please review [our security policy](https://github.com/octobercms/october/security/policy) on how to report security vulnerabilities.
Please review [our security policy](https://github.com/wintercms/winter/security/policy) on how to report security vulnerabilities.

## Reporting an issue with OctoberCMS
## Reporting an issue with Winter CMS

>**NOTE:** If your issue is related to an OctoberCMS plugin, please see the [Reporting an issue with an OctoberCMS plugin](#reporting-an-issue-with-an-octobercms-plugin) section below.
>**NOTE:** If your issue is related to an Winter CMS plugin, please see the [Reporting an issue with an Winter CMS plugin](#reporting-an-issue-with-an-octobercms-plugin) section below.
We work hard to process bugs that are reported, to assist with this please ensure the following details are always included:

- **Summary**: Make sure your summary reflects what the problem is and where it is. Provide as much detail as possible, the more information we have to work with the more likely it is that your problem can be solved.

- **Reproduce steps**: Clearly mention the steps to reproduce the bug.

- **Expected behavior**: Describe how OctoberCMS should behave on above mentioned steps.
- **Expected behavior**: Describe how Winter CMS should behave on above mentioned steps.

- **Actual behavior**: What is the actual result on running above steps i.e. the bug behavior - **include any error messages**.

Expand All @@ -37,31 +37,31 @@ If possible, please provide any screenshots or GIFs of the issue occurring to pr

2. **Search for similar issues.** Perhaps someone has already reported your issue! If so, please add clarification and/or more information to the **existing** issue.

3. **Create a new issue.** If you don't find any similar issues, you can report your issue via the ["issues" tab](https://github.com/octobercms/october/issues) once you've logged in.
3. **Create a new issue.** If you don't find any similar issues, you can report your issue via the ["issues" tab](https://github.com/wintercms/winter/issues) once you've logged in.

4. **Monitor your issue and respond to questions.** It may be necessary to provide additional information upon request or you might be asked if the issue still occurs after an update.

5. **Close your issue.** In case you notice that the issue doesn't occur anymore, you can close the issue yourself (don't forget to add a note saying that the issue is resolved and ideally any additional information on how it was resolved).

If you find out your bug is actually a duplicate of another bug and only notice that after you created it, please also close your bug with a short reference to the other issue that was there before.

#### Reporting an issue with an OctoberCMS plugin
#### Reporting an issue with an Winter CMS plugin

>Please don't use the main GitHub for reporting issues with plugins.
If you have found a bug in a plugin, the best place to report it is with the [plugin author](https://octobercms.com/plugins).
If you have found a bug in a plugin, the best place to report it is with the [plugin author](https://wintercms.com/plugins).

If you are unable to contact the plugin author and the issue prevents the plugin from being used correctly, please feel free to email `hello@octobercms.com`, mentioning the plugin name, URL and the issue found. We will then determine if the plugin needs to be delisted.

#### Escalation process

We do our best to attend to all reported issues. If you have an important issue that requires attention, consider submitting a bounty using the [OctoberCMS Bounty Program](https://www.bountysource.com/teams/october).
We do our best to attend to all reported issues. If you have an important issue that requires attention, consider submitting a bounty using the [Winter CMS Bounty Program](https://www.bountysource.com/teams/october).

## Making a Feature Request

>**NOTE:** Please don't use GitHub issues for suggesting a new feature. If you have a feature idea, the best place to suggest it is the [OctoberCMS website forum](https://octobercms.com/forum/chan/feature-requests).
>**NOTE:** Please don't use GitHub issues for suggesting a new feature. If you have a feature idea, the best place to suggest it is the [Winter CMS website forum](https://wintercms.com/forum/chan/feature-requests).
Only use GitHub if you are planning on contributing a new feature and developing it. If you want to discuss your idea first, before "officially" posting it anywhere, you can always join us on [IRC](https://octobercms.com/chat) or [Slack](https://octobercms.slack.com).
Only use GitHub if you are planning on contributing a new feature and developing it. If you want to discuss your idea first, before "officially" posting it anywhere, you can always join us on [IRC](https://wintercms.com/chat) or [Slack](https://octobercms.slack.com).

#### GitHub feature requests

Expand All @@ -84,18 +84,18 @@ Thank you for your contributions!

#### Best practices

It is ideal to keep your development branch or fork synchronised with the core OctoberCMS `develop` branch when submitting Pull Requests, as this minimises the possibility of merge conflicts.
It is ideal to keep your development branch or fork synchronised with the core Winter CMS `develop` branch when submitting Pull Requests, as this minimises the possibility of merge conflicts.

To keep in sync with OctoberCMS, add the core OctoberCMS repository as a Git remote (ie. `upstream`) and pull changes from the OctoberCMS repository into your local `develop` branch as often as possible:
To keep in sync with Winter CMS, add the core Winter CMS repository as a Git remote (ie. `upstream`) and pull changes from the Winter CMS repository into your local `develop` branch as often as possible:

```
git remote add upstream git@github.com:octobercms/october.git
git remote add upstream git@github.com:wintercms/winter.git
git fetch upstream
git checkout develop
git pull upstream develop
```

This ensures that your local `develop` branch matches OctoberCMS. When developing a pull request, it is best to use your own development branch. For example, creating a fix to improve spelling on a language file could be made into a branch called `lang-en-spelling-fixes`, which can be branched off from the `develop` branch.
This ensures that your local `develop` branch matches Winter CMS. When developing a pull request, it is best to use your own development branch. For example, creating a fix to improve spelling on a language file could be made into a branch called `lang-en-spelling-fixes`, which can be branched off from the `develop` branch.

```
git checkout -b lang-en-spelling-fixes develop
Expand All @@ -107,17 +107,17 @@ When you wish to update your development branch with the latest changes from the
git merge develop
```

This will merge all the latest changes from the OctoberCMS `develop` branch into your development branch.
This will merge all the latest changes from the Winter CMS `develop` branch into your development branch.

#### Resolving merge conflicts

Occassionally, you may encounter a merge conflict with your Pull Request. This most commonly occurs if another change made to the OctoberCMS repository was made to a file that your Pull Request has also changed.
Occassionally, you may encounter a merge conflict with your Pull Request. This most commonly occurs if another change made to the Winter CMS repository was made to a file that your Pull Request has also changed.

It is the responsibility of the author of the Pull Request to resolve any merge conflicts before their Pull Request is accepted.

You should ensure that your local copy of OctoberCMS is synchronised with with the `develop` branch in the OctoberCMS repository. Please follow the [steps above](#best-practices) to synchronise the repositories.
You should ensure that your local copy of Winter CMS is synchronised with with the `develop` branch in the Winter CMS repository. Please follow the [steps above](#best-practices) to synchronise the repositories.

If Git reports that your changes have conflicts, you will need to resolve the changes in a way that includes the changes from the OctoberCMS repository as well as implementing your Pull Request's changes. See GitHub's guide to [resolving a merge conflict](https://help.github.com/en/articles/resolving-a-merge-conflict-using-the-command-line) for tips on resolving conflicts.
If Git reports that your changes have conflicts, you will need to resolve the changes in a way that includes the changes from the Winter CMS repository as well as implementing your Pull Request's changes. See GitHub's guide to [resolving a merge conflict](https://help.github.com/en/articles/resolving-a-merge-conflict-using-the-command-line) for tips on resolving conflicts.

#### PSR Coding standards

Expand All @@ -131,17 +131,17 @@ To validate your changes against our coding standards, you may run `./vendor/bin

#### Team rules

The OctoberCMS team follows the [developer guidelines](https://octobercms.com/docs/help/developer-guide) as much as possible.
The Winter CMS team follows the [developer guidelines](https://wintercms.com/docs/help/developer-guide) as much as possible.

## Testing a Pull Request

Although we aim to test all pull requests made to the OctoberCMS repository, the maintainers of OctoberCMS are volunteers and may not be able to promptly attend to all pull requests.
Although we aim to test all pull requests made to the Winter CMS repository, the maintainers of Winter CMS are volunteers and may not be able to promptly attend to all pull requests.

To help speed things up, any assistance with testing Pull Requests and fixes will be very appreciated. The best Pull Requests to test are those that are tagged as [**Testing Needed**](https://github.com/octobercms/october/pulls?q=is%3Apr+is%3Aopen+label%3A%22Testing+Needed%22) in the repository.
To help speed things up, any assistance with testing Pull Requests and fixes will be very appreciated. The best Pull Requests to test are those that are tagged as [**Testing Needed**](https://github.com/wintercms/winter/pulls?q=is%3Apr+is%3Aopen+label%3A%22Testing+Needed%22) in the repository.

To test a Pull Request, you can use the steps below in a terminal or command-line interface to create a fresh installation of OctoberCMS with the changes made in the Pull Request, ready to test. In this example, we have a user called `qwerty123` that has created a pull request with an ID of `#4509`.
To test a Pull Request, you can use the steps below in a terminal or command-line interface to create a fresh installation of Winter CMS with the changes made in the Pull Request, ready to test. In this example, we have a user called `qwerty123` that has created a pull request with an ID of `#4509`.

1. Check out a copy of the OctoberCMS repository to a folder that you can view in your web browser: `git clone git@github.com:octobercms/october.git`. This will add the files into a subfolder called `october`.
1. Check out a copy of the Winter CMS repository to a folder that you can view in your web browser: `git clone git@github.com:wintercms/winter.git`. This will add the files into a subfolder called `october`.

2. Then, go to the `october` subfolder and check out **@qwerty123**'s changes in a branch in your local repository: `git fetch origin pull/4509/head:pr-4509`. This will pull their changes into a branch called `pr-4509`. You will then need to check out the branch: `git checkout pr-4509`.

Expand Down
3 changes: 1 addition & 2 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# These are supported funding model platforms
custom: ['https://octobercms.com/premium-support']
open_collective: octobercms
github: LukeTowers
custom: ['https://wintercms.com/premium-support']
10 changes: 4 additions & 6 deletions .github/ISSUE_TEMPLATE/0_IMMEDIATE_SUPPORT.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
---
name: "🚨 Immediate Support"
about: 'I use October and it just broke! Help me!'
about: 'I use Winter and it just broke! Help me!'
---

This repository is only for reporting reproducible bugs or problems. If you need support, please use the following options:

- Slack: https://octobercms.slack.com (Get an invite: https://octobercms-slack.herokuapp.com/)
- Live chat (IRC): https://octobercms.com/chat - **Note:** Not as active as Slack
- Forum: https://octobercms.com/forum
- Stack Overflow: https://stackoverflow.com/questions/tagged/octobercms
- Slack: https://discord.gg/D5MFSPH6Ux
- Stack Overflow: https://stackoverflow.com/questions/tagged/wintercms

If you rely on OctoberCMS for your business consider purchasing a paid support plan! Send an email to octobercms@luketowers.ca to get started.
If you rely on Winter CMS for your business consider purchasing a paid support plan! Send an email to wintercms@luketowers.ca to get started.

Thanks!
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/1_BUG_REPORT.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
name: "🐛 Bug Report"
about: 'Report a general OctoberCMS issue. See our policy below if reporting a security issue.'
about: 'Report a general Winter CMS issue. See our policy below if reporting a security issue.'
labels: 'Status: Review Needed, Type: Unconfirmed Bug'
---

- OctoberCMS Build: ### <!-- Or Commit hash if using composer -->
- Winter CMS Build: ### <!-- Or Commit hash if using composer -->
- PHP Version:
- Database Engine: <!-- Remove if not using a database -->
- Plugins Installed: <!-- In the format of Author.Plugin-v1.2.0 -->
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/2_MARKETPLACE_SUPPORT.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: "🛒 Marketplace Support"
about: 'For reporting any issues with the marketplace, send an email to hello@octobercms.com'
about: 'For reporting any issues with the marketplace, send an email to wintercms@luketowers.ca'
---

All marketplace support issues will be addressed through email support.
Expand Down
7 changes: 3 additions & 4 deletions .github/ISSUE_TEMPLATE/3_GENERAL_SUPPORT.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
---
name: "⚠️ General Support"
about: 'This repository is only for reporting bugs or problems. If you need help using OctoberCMS, see: https://octobercms.com/support'
about: 'This repository is only for reporting bugs or problems. If you need help using Winter CMS, see: https://wintercms.com/support'
---

This repository is only for reporting bugs or problems. If you need support, please use the following options:

- Forum: https://octobercms.com/forum
- Slack: https://octobercms.slack.com (Get an invite: https://octobercms-slack.herokuapp.com/)
- Stack Overflow: https://stackoverflow.com/questions/tagged/octobercms
- Discord: https://discord.gg/D5MFSPH6Ux
- Stack Overflow: https://stackoverflow.com/questions/tagged/wintercms

Thanks!
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/4_FEATURE_REQUEST.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ name: "💡 Feature Request"
about: 'For ideas or feature requests, make a PR or talk to the core members on Slack'
---

If you would like to propose new features, please make a pull request. Alternatively, you may message the core team on the OctoberCMS Slack.
If you would like to propose new features, please make a pull request. Alternatively, you may message the core team on the Winter CMS Slack.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/5_DOCUMENTATION.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
name: "📚 Documentation Issue"
about: 'For documentation issues, see: https://github.com/octobercms/docs/issues'
about: 'For documentation issues, see: https://github.com/wintercms/docs/issues'
---

The OctoberCMS documentation has its own dedicated repository. Please open your documentation-related issue at https://github.com/octobercms/docs/issues.
The Winter CMS documentation has its own dedicated repository. Please open your documentation-related issue at https://github.com/wintercms/docs/issues.

> **NOTE:** Since documentation issues are not reviewed very often, it's best to simply make a pull request to correct the issue you have found!**
Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ Pull Requests without a descriptive title, thorough description, or tests will b
Please include the benefit to end users; the reasons it does not break any existing features; how it makes building web applications easier, etc. The more detail the better.
If documentation improvements are required, you are expected to make a simultaneous pull request to https://github.com/octobercms/docs to update the documentation
If documentation improvements are required, you are expected to make a simultaneous pull request to https://github.com/wintercms/docs to update the documentation
-->
8 changes: 4 additions & 4 deletions .github/workflows/archive.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ jobs:
This issue will be closed and archived in 3 days, as there has been no activity in the last 60 days.
If this issue is still relevant or you would like to see it actioned, please respond and we will re-open this issue.
If this issue is critical to your business, consider joining the [Premium Support Program](https://octobercms.com/premium-support) where a Service Level Agreement is offered.
If this issue is critical to your business, consider joining the [Premium Support Program](https://wintercms.com/premium-support) where a Service Level Agreement is offered.
stale-pr-message: >
This pull request will be closed and archived in 3 days, as there has been no activity in the last 60 days.
If this is still being worked on, please respond and we will re-open this pull request.
If this pull request is critical to your business, consider joining the [Premium Support Program](https://octobercms.com/premium-support) where a Service Level Agreement is offered.
If this pull request is critical to your business, consider joining the [Premium Support Program](https://wintercms.com/premium-support) where a Service Level Agreement is offered.
stale-issue-label: 'Status: Archived'
stale-pr-label: 'Status: Archived'
exempt-issue-label: 'Status: In Progress'
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/code-quality-pr.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ jobs:
tools: composer:v1
- name: Install Composer dependencies
run: composer install --no-interaction --no-progress --no-suggest
- name: Reset October modules and library
- name: Reset Winter modules and library
run: |
git reset --hard HEAD
rm -rf ./vendor/october/rain
wget https://github.com/octobercms/library/archive/develop.zip -O ./vendor/october/develop.zip
unzip ./vendor/october/develop.zip -d ./vendor/october
mv ./vendor/october/library-develop ./vendor/october/rain
rm -rf ./vendor/wintercms/storm
wget https://github.com/wintercms/library/archive/develop.zip -O ./vendor/wintercms/develop.zip
unzip ./vendor/wintercms/develop.zip -d ./vendor/wintercms
mv ./vendor/wintercms/library-develop ./vendor/wintercms/storm
composer dump-autoload
- name: Run code quality checks
run: |
Expand Down
Loading

0 comments on commit 7d80b77

Please sign in to comment.