Skip to content

Commit 35c70d7

Browse files
committed
Merge branch 'develop' into user-set-password
2 parents a07a768 + df8495e commit 35c70d7

538 files changed

Lines changed: 40922 additions & 11785 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitattributes

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Forces Git to handle line endings, preventing any changes (like from editors or tools) being commited.
2+
# Also improves reliability of tools like Git Lens.
3+
* text=auto
4+
5+
# NPM always rewrites package.json and package-lock.json to lf.
6+
# This stops the annoying tendancy for false positive changes to appear under Windows.
7+
package.json text=lf
8+
package-lock.json text=lf

.github/CONTRIBUTING.md

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
# Guidelines for Getting Help with UserFrosting
2+
3+
**Before** you open a new issue or ask a question in chat, you **must** read these guidelines. If it is evident from your issue that you failed to research your question properly, your issue may be closed without being answered.
4+
5+
## Troubleshooting
6+
7+
There are a few common stumbling blocks that new users face when setting up UserFrosting for the first time. If you are new to the current version of UserFrosting, please first look at the [basic requirements and installation instructions](https://learn.userfrosting.com/basics/requirements/basic-stack).
8+
9+
If you don't find what you're looking for in the troubleshooting page, then please check the [wiki](https://github.com/userfrosting/UserFrosting/wiki) and [existing issues](https://github.com/alexweissman/UserFrosting/issues?utf8=%E2%9C%93&q=is%3Aissue), both opened and closed. Your question may have already been asked and answered before!
10+
11+
You can also search for help on Stack Overflow or in our [Forums](https://forums.userfrosting.com/). In addition to the tags for the components that UF builds upon, such as [Slim](http://stackoverflow.com/questions/tagged/slim), [Twig](http://stackoverflow.com/questions/tagged/twig), [Eloquent](http://stackoverflow.com/questions/tagged/eloquent), [jQuery Validate](http://stackoverflow.com/questions/tagged/jquery-validate), [Select2](http://stackoverflow.com/questions/tagged/jquery-select2), there is now a [UserFrosting tag](http://stackoverflow.com/questions/tagged/userfrosting) as well.
12+
13+
There are also tags for the utilities upon which UserFrosting depends, such as [Composer](http://stackoverflow.com/questions/tagged/composer-php) and [Git](http://stackoverflow.com/questions/tagged/git).
14+
15+
## Asking for Help
16+
17+
In general, the Github issue tracker should only be used for bug reports and feature requests. If you're just having trouble getting something to work, you should ask on Stack Overflow or in our [Forums](https://forums.userfrosting.com/) instead. Tag your question with the `userfrosting` tag, and optionally with any tags specific to the relevant underlying technologies, such as `slim`, `twig`, `eloquent`, `composer`, etc. You should also mention the version of UserFrosting that you are using.
18+
19+
After posting a question on Stack Overflow or in our [Forums](https://forums.userfrosting.com/), please [link to it in chat](https://chat.userfrosting.com). This will ensure that more people see it, and provide a place where we can discuss and help clarify your question.
20+
21+
On Github, Chat, and Stack Overflow, please keep in mind the following:
22+
23+
1. Remember that courtesy and proper grammar go a long way. Please take the time to craft a **precise, polite issue**. We will do our best to help, but remember that this is an open-source project - none of us are getting paid a salary to develop this project, or act as your personal support hotline :wink:
24+
25+
2. Report any errors in detail. Vague issues like "it doesn't work when I do this" are not helpful. Show that you have put some effort into identifying the cause of the error.
26+
27+
3. There are three main places where you may find error messages:
28+
29+
- Backend (PHP-related) fatal errors: in your PHP error log. This is usually a file called `php_error_log` or something like that. In XAMPP, the default location of this file is `XAMPP/xamppfiles/logs/`. For other web hosting platforms, please consult the documentation or do a quick Google search (i.e. "where is the php error log in _____"). Some web hosts may provide a special interface for accessing the php error log, through ssh, cpanel, etc. Please ask them directly for help with this.
30+
31+
- Non-fatal PHP errors will be logged in your UserFrosting error log. Look for your `app/logs/errors.log` file.
32+
33+
- Frontend (Javascript-related) errors: in your browser's Javascript console. See [this guide](https://learn.userfrosting.com/background/client-side) to using your browser console.
34+
35+
You should also try testing your code in a local development environment, to separate **code-related** issues from **server** issues. In general, we recommend that you install a local development server on your computer, rather than [testing your code directly on the production server](https://pbs.twimg.com/media/BxfENwpIYAAcHqQ.png). This means you can test your code directly on your own computer, making development faster and without the risk of exposing sensitive information to the public. We recommend installing [XAMPP](https://www.apachefriends.org) if you don't already have a local server set up.
36+
37+
## Contributing to the Codebase
38+
39+
We welcome your technical expertise! But first, please join us in [chat](https://chat.userfrosting.com) to discuss your proposed changes/fixes/enhancements before you get started. At least one member of our development team will usually be around.
40+
41+
Please also be sure to read our [style guidelines](../STYLE-GUIDE.md).
42+
43+
When it's time to integrate changes, our git flow more or less follows http://nvie.com/posts/a-successful-git-branching-model/.
44+
45+
### Branches
46+
47+
#### `master`
48+
The current release or release candidate. Always numbered as `major.minor.revision`, possibly with an `-alpha`, `-beta` or `-RC` extension as well. Commits should **never** be send directly on this branch.
49+
50+
#### `hotfix`
51+
Contains the next bug fix release, typically matching the next `revision` version. Any changes not introducing a breaking change can be committed to this branch. Always numbered as `major.minor.revision`.
52+
53+
When ready, changes should be merged into both **master** and **develop**.
54+
55+
#### `develop`
56+
Contains breaking changes that will need to wait for the next version to be integrated. Typically matched the next `minor` version. Always numbered as `major.minor.x`.
57+
58+
When ready, changes should be merged into both **master** and **hotfix**.
59+
60+
#### `feature-*`
61+
New features that introduce some breaking changes or incomplete code should be committed in a separate `feature-{name}` branch.
62+
63+
When ready, the branch should be **[squashed-merged](https://github.com/blog/2141-squash-your-commits)** ([guide](https://stackoverflow.com/a/5309051/445757)) into `develop` (or `hotfix` if it doesn't introduce a breaking change).
64+
65+
### Releases
66+
67+
After every release, the `hotfix` branch (and possibly `develop`, for minor/major releases) should immediately be version-bumped. That way, new changes can be accumulated until the next release.
68+
69+
When a new version is created, the version number need to be changed in `app/define.php`. `CHANGELOG.md` should also be updated and the associated tag should be created on Github.
70+
71+
#### Alpha/beta/RC releases
72+
73+
During alpha/beta/RC, a release candidate always sits on the `master` branch. During the alpha/beta phase, major changes can still be integrated into `master` from `develop`. However, this should bump the revision number instead of the minor/major number. During RC, only _hotfixes_ can be merged into `master`.
74+
75+
## Working together
76+
77+
### Issues
78+
79+
Issues are used as a todo list. Each issue represent something that needs to be fixed, added or improved. Be sure to assign issues to yourself when working on something so everyones knows this issue is taken care of.
80+
81+
Issues are tagged to represent the feature or category it refers to. We also have some special tags to help organize issues. These includes:
82+
83+
- [`good first issue`](https://github.com/userfrosting/UserFrosting/labels/good%20first%20issue): If this is your first time contributing to UserFrosting, look for the `good first issue` tag. It's associated with easier issues anyone can tackle.
84+
85+
- [`up-for-grabs`](https://github.com/userfrosting/UserFrosting/labels/up-for-grabs): Theses issues have not yet been assigned to anybody. Look for theses when you want to start working on a new issue.
86+
87+
- [`needs discussion`](https://github.com/userfrosting/UserFrosting/labels/needs%20discussion) : This issue needs to be discussed with the dev team before being implemented as more information is required, questions remain or a higher level decision needs to be made.
88+
89+
- [`needs more info`](https://github.com/userfrosting/UserFrosting/labels/needs%20more%20info): More information is required from the author of the issue.
90+
91+
### Milestones
92+
93+
In order to keep a clear roadmap, milestones are used to track what is happening and what needs to be done. Milestones are used to classify problems by:
94+
- Things that need to be done ASAP
95+
- Things we are doing right now
96+
- Things we will probably do soon
97+
- Things we probably will not do soon
98+
99+
**Things that need to be done ASAP**: this is the highest priority and this milestone should always be empty. Issues related to important bug fixes should be set on this milestone immediately. The milestone always refers to the next version of _revision_, also known as the next bugfix version.
100+
101+
**Things we are doing right now**: this is the "main" milestone we are currently working on. Usually represents the next `minor` version, but may also represent the next major version when the focus is on the next major release.
102+
103+
**Things we’ll probably do soon**: It's a "Next Tasks" milestone. These tasks will be addressed in the near future, but not close enough for the next version. Usually represents the second minor revision **and** the next major release.
104+
105+
**Things we probably won’t do soon**: We refer to these issues and sometimes look through them, but they are easy to ignore and sometimes intentionally ignored. Represent issues without milestones that do not have a defined timeframe.
106+
107+
108+
To maintain a clear history of progress on each milestone, milestones must be closed when completed and the corresponding version released. A new milestone must then be created for the next release. In addition, the milestone version must be updated when new versions are released.
109+
110+
## Learn documentation
111+
112+
The [Learn Documentation](https://learn.userfrosting.com) should always be updated along side code changes.
113+
114+
Changes to the [learn repository](https://github.com/userfrosting/learn) should follow the same logic as the main repository, ie. any changes applied to the `hotfix` branch should be documented in the learn `hotfix` branch. This also apply to `feature-*` branches.
115+
116+
Additionally, the `learn` repository can have `dev-*` for learn specific features and fixes.
117+
118+
## Building the API documentation
119+
120+
To build the API documentation, install [ApiGen](http://www.apigen.org/) globally and then run:
121+
122+
`apigen generate --source UserFrosting/app,userfrosting-assets/src,userfrosting-config/Config,userfrosting-fortress/Fortress,userfrosting-i18n/I18n,userfrosting-session/Session,userfrosting-support/Support --destination userfrosting-api --exclude *vendor*,*_meta* --template-theme "bootstrap"`
123+
124+
from inside your dev directory.
125+
126+
## Automatically fixing coding style with PHP-CS-Fixer
127+
128+
[PHP-CS-Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer) can be used to automatically fix PHP code styling. UserFrosting provides a project specific configuration file ([`.php_cs`](.php_cs)) with a set of rules reflecting our [style guidelines](../STYLE-GUIDE.md). This tool should be used before submitting any code change to assure the style guidelines are met. Every sprinkles will also be parsed by the fixer.
129+
130+
PHP-CS-Fixer is automatically loaded by Composer and can be used from the UserFrosting root directory :
131+
132+
```
133+
app/vendor/bin/php-cs-fixer fix
134+
```
135+
136+
## Useful tools
137+
138+
If you are using **Atom**, be sure to checkout theses useful packages :
139+
- [Docblockr](https://atom.io/packages/docblockr) : Used to generate [documentation block](https://github.com/userfrosting/UserFrosting/blob/master/STYLE-GUIDE.md#documentation).
140+
- [php-ide-serenata](https://atom.io/packages/php-ide-serenata) : Integrates [Serenata](https://gitlab.com/Serenata/Serenata) as PHP IDE, providing autocompletion, code navigation, refactoring, signature help, linting and annotations.

.github/ISSUE_TEMPLATE.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
🛑 STOP!
2+
3+
Before you open an issue:
4+
5+
1. Make sure that your issue is a BUG or FEATURE REQUEST. General usage and troubleshooting questions should be directed to the [forums](https://forums.userfrosting.com), [chat](https://chat.userfrosting.com), or [Stack Overflow](https://stackoverflow.com/questions/tagged/userfrosting). You can also consult our chapter on [common problems](https://learn.userfrosting.com/troubleshooting/common-problems). Issues asking for general support WILL BE CLOSED automatically.
6+
2. Search the forums and current issues, both open and closed, for a similar issue. If the bug is still present but the relevant issue has been closed, you may ask us to reopen the issue. Duplicate issues will be closed automatically.
7+
3. Make sure that you are using the latest stable version of UserFrosting (see the [release history](https://github.com/userfrosting/UserFrosting/releases)). Support for UserFrosting 3.x or earlier may be limited.
8+
9+
If you are CERTAIN that it is appropriate to open a new issue, you must:
10+
11+
1. Format any code snippets or command-line output using Markdown [code fences](https://help.github.com/articles/creating-and-highlighting-code-blocks/), and make sure your code is properly indented. **This is extremely important** - poorly formatted code is difficult to read and reflects badly on you as a programmer.
12+
2. Remember that courtesy and proper grammar go a long way. Please take the time to craft a precise, polite issue. We will do our best to help, but remember that this is an open-source project - none of us are getting paid a salary to develop this project, or act as your personal support hotline ;-)
13+
1. State the steps needed to reproduce the problem.
14+
2. Mention your version of UserFrosting, as well as the browser(s) and operating system(s) in which the problem occurs.
15+
3. Report any errors in detail. Vague issues like "it doesn't work when I do this" are not helpful. Show that you have put some effort into identifying the cause of the error. See the section on [debugging](https://learn.userfrosting.com/troubleshooting/debugging) for information on how to get more details about errors and other problems.
16+
3. You should always test your code in a local development environment, to separate code-related issues from server issues. In general, we recommend that you install a local development server on your computer, rather than testing your code directly on the production server. This means you can test your code directly on your own computer, making development faster and without the risk of exposing sensitive information to the public. We recommend installing Vagrant and Homestead if you don't already have a local server set up.
17+
4. If you are not conversationally proficient in English, do NOT just post a machine translation (e.g. Google Translate) to GitHub. Get help in crafting your question, either via the [forums](https://forums.userfrosting.com) or in [chat](https://chat.userfrosting.com). If all else fails, you may post your bug report or feature request in your native language, with a machine translation below that. We will tag it with `translation-needed` so that others who speak your language can find it.
18+
5. Clear out this placeholder text.
19+
6. Consider supporting this project by [making a donation to our Open Collective](https://opencollective.com/userfrosting/donate)!

.github/stale.yml

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Configuration for probot-stale - https://github.com/probot/stale
2+
3+
# Number of days of inactivity before an Issue or Pull Request becomes stale
4+
daysUntilStale: 550
5+
6+
# Number of days of inactivity before an Issue or Pull Request with the stale label is closed.
7+
# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
8+
daysUntilClose: 7
9+
10+
# Only issues or pull requests with all of these labels are check if stale. Defaults to `[]` (disabled)
11+
onlyLabels: []
12+
13+
# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable
14+
exemptLabels:
15+
- "confirmed bug"
16+
- security
17+
- "long-range planning"
18+
19+
# Set to true to ignore issues in a project (defaults to false)
20+
exemptProjects: false
21+
22+
# Set to true to ignore issues in a milestone (defaults to false)
23+
exemptMilestones: true
24+
25+
# Set to true to ignore issues with an assignee (defaults to false)
26+
exemptAssignees: false
27+
28+
# Label to use when marking as stale
29+
staleLabel: wontfix
30+
31+
# Comment to post when marking as stale. Set to `false` to disable
32+
markComment: >
33+
This issue has been automatically marked as stale because it has not had
34+
recent activity. It will be closed if no further activity occurs. Thank you
35+
for your contributions.
36+
37+
# Comment to post when removing the stale label.
38+
# unmarkComment: >
39+
# Your comment here.
40+
41+
# Comment to post when closing a stale Issue or Pull Request.
42+
# closeComment: >
43+
# Your comment here.
44+
45+
# Limit the number of actions per hour, from 1-30. Default is 30
46+
limitPerRun: 30
47+
48+
# Limit to only `issues` or `pulls`
49+
# only: issues
50+
51+
# Optionally, specify configuration settings that are specific to just 'issues' or 'pulls':
52+
# pulls:
53+
# daysUntilStale: 30
54+
# markComment: >
55+
# This pull request has been automatically marked as stale because it has not had
56+
# recent activity. It will be closed if no further activity occurs. Thank you
57+
# for your contributions.
58+
59+
# issues:
60+
# exemptLabels:
61+
# - confirmed

.gitignore

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
# Ignores my text editor metadata
1+
# Ignores text editor metadata
22
*.komodoproject
3+
.php_cs.cache
34

45
# Ignores Mac metadata. You can configure this globally if you use a Mac: http://islegend.com/development/setting-global-gitignore-mac-windows/
56
.DS_Store
@@ -14,15 +15,17 @@ app/.env
1415
composer.lock
1516
composer.phar
1617

17-
# Ignore log, cache, and sessions directories
18+
# Ignore log, cache, sessions and storage directories
1819
app/cache/*
1920
app/logs/*
2021
app/sessions/*
22+
app/storage/*
2123

22-
# Unignore log, cache, and sessions .gitkeeps
24+
# Unignore log, cache, sessions and storage .gitkeeps
2325
!app/cache/.gitkeep
2426
!app/logs/.gitkeep
2527
!app/sessions/.gitkeep
28+
!app/storage/.gitkeep
2629

2730
# Ignore bower vendor assets
2831
/app/sprinkles/*/assets/vendor/
@@ -58,3 +61,17 @@ public/css/min/*
5861

5962
# Ignore personal config files (v0.3.x)
6063
app/config-userfrosting.php
64+
65+
# Physical database storage for containers (?)
66+
app/database/userfrosting.db
67+
68+
# Ignore vendor assets
69+
app/assets/*
70+
71+
# Ignore Vagrant & Homestead VM
72+
vagrant/Homestead/
73+
.vagrant/*
74+
75+
# Igore npm lockfile
76+
build/package-lock.json
77+
build/package.lock

0 commit comments

Comments
 (0)