Merge pull request #1 from bcit-ci/develop

updated version

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,36 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+---
+name: Bug report
+about: Help us improve the framework by reporting bugs!
+
+---
+
+**Direction**
+We use github issues to track bugs, not for support. 
+If you have a support question, or a feature request, raise these as threads on our
+[forum](https://forum.codeigniter.com/index.php).
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**CodeIgniter 4 version**
+Which version (and branch, if applicable) the bug is in.
+
+**Affected module(s)**
+Which package or class is the bug in, if known.
+
+**Expected behavior, and steps to reproduce if appropriate**
+A clear and concise description of what you expected to happen,
+and how you got there. 
+Feel free to include a text/log extract, but use a pastebin facility for any
+screenshots you deem necessary.
+
+**Context**
+ - OS: [e.g. Windows 99]
+ - Web server [e.g. Apache 1.2.3]
+ - PHP version [e.g. 6.5.4]

.gitignore

@@ -57,6 +57,10 @@ writable/logs/*
 !writable/logs/index.html
 !writable/logs/.htaccess
 
+writable/session/*
+!writable/session/index.html
+!writable/session/.htaccess
+
 writable/uploads/*
 !writable/uploads/index.html
 !writable/uploads/.htaccess
@@ -127,3 +131,4 @@ nb-configuration.xml
 
 /results/
 /phpunit*.xml
+

.travis.yml

@@ -21,6 +21,7 @@ dist: precise
 env:
  - DB=mysqli
  - DB=postgres
+ - DB=sqlite
 
 services:
  - memcached

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at admin@codeigniter.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,22 @@
+Each pull request should address a single issue, and have a meaningful title.
+
+**Description**
+Explain what you have changed, and why.
+
+**Checklist:**
+- [ ] Securely signed commits
+- [ ] Component(s) with PHPdocs
+- [ ] Unit testing, with >80% coverage
+- [ ] User guide updated
+- [ ] Conforms to style guide
+
+---------Remove from here down in your description----------
+
+**Notes**
+- Pull requests must be in English
+- If the PR solves an issue, reference it with a suitable verb and the issue number
+(e.g. fixes <hash>12345
+- Unsolicited PRs will be considered, but there is no guarantee of acceptance
+- Pull requests should be from a feature branch in the contributor's fork of the repository
+ to the develop branch of the project repository
+

admin/README.md

@@ -0,0 +1,6 @@
+# CodeIgniter 4 Admin
+
+This folder contains tools or docs useful for project maintainers.
+
+- [docbot](./docbot.md) - build & deploy user guide
+- [release](./release.md) - build & deploy framework release

admin/docbot

@@ -0,0 +1,36 @@
+#!/bin/bash
+
+# Rebuild and deploy CodeIgniter4 user guide
+
+UPSTREAM=https://github.com/bcit-ci/CodeIgniter4.git
+
+# Prepare the nested repo clone folder
+cd user_guide_src
+rm -rf build/*
+mkdir build/html
+
+# Get ready for git
+cd build/html
+git init
+git remote add origin $UPSTREAM
+git fetch 
+git checkout gh-pages
+git reset --hard origin/gh-pages
+rm -r *
+
+# Make the new user guide
+cd ../..
+make html
+
+# All done?
+if [ $# -lt 1 ]; then
+ exit 0
+fi
+
+# Optionally update the remote repo
+if [ $1 = "deploy" ]; then
+ cd build/html
+ git add .
+ git commit -S -m "Docbot synching"
+ git push -f origin gh-pages
+fi

admin/docbot.md

@@ -0,0 +1,33 @@
+# docbot
+
+Builds & deploys user guide.
+
+The CI4 user guide, warts & all, is rebuilt in a nested
+repository clone (`user_guide_src/build/html`), with the result
+optionally pushed to the `gh-pages` branch of the repo.
+That would then be publically visible as the in-progress
+version of the [User Guide](https://bcit-ci.github.io/CodeIgniter4/).
+
+## Audience
+
+This script is intended for use by framework maintainers,
+i.e. someone with commit rights on the CI4 repository.
+
+This script wraps the conventional user guide building,
+i.e. `user_guide_src/make html`, with additional
+steps.
+
+You will be prompted for your github credentials and
+GPG-signing key as appropriate.
+
+## Usage
+
+Inside a shell prompt, in the project root:
+
+ `admin/docbot [deploy]`
+
+If "deploy" is not added, the script execution is considered
+a trial run, and nothing is pushed to the repo.
+
+Whether or not deployed, the results are left inside
+user_guide_src/build (which is git ignored).

admin/post_release

@@ -0,0 +1,91 @@
+#~/bin/bash
+
+## Cleanup after a framework release
+
+UPSTREAM=https://github.com/bcit-ci/CodeIgniter4.git
+version=4
+qualifier=
+
+branch=post-release-
+devonly='.github/* admin/* build/* contributing/* user_guide_src/* CODE_OF_CONDUCT.md \
+DCO.txt PULL_REQUEST_TEMPLATE.md'
+which=release
+
+BOLD='\033[1m'
+NORMAL='\033[0m'
+COLOR='\033[1;31m'
+ERROR='\033[0;31m'
+
+echo -e "${BOLD}${COLOR}CodeIgniter4 release cleanup${NORMAL}"
+echo '----------------------------'
+
+#---------------------------------------------------
+# Check arguments
+echo -e "${BOLD}Checking arguments...${NORMAL}"
+
+if [ $# -lt 1 ]; then
+ echo "You really need to read the directions first!"
+ exit 1
+fi
+
+version=$1
+if [ $# -gt 1 ]; then
+ qualifier="-${2}"
+ which='pre-release'
+fi
+release_branch="release-$version$qualifier"
+branch="post-${release_branch}"
+
+#---------------------------------------------------
+# Create the post-release branch
+echo -e "${BOLD}Creating $branch${NORMAL}"
+
+git checkout $release_branch
+git branch -d $branch # remove the branch if there
+git checkout -b $branch
+
+#---------------------------------------------------
+# Put our house back in order
+echo -e "${BOLD}Put our house back in order${NORMAL}"
+
+mv -r admin/previous-gitignore .gitignore
+rm -Rf docs
+
+#---------------------------------------------------
+# Add next version block in changelog.rst
+echo -e "${BOLD}Setup next release${NORMAL}"
+sed -i '5 i\
+Version |release|
+====================================================
+
+Release Date: Not Released
+' user_guide_src/source/changelog.rst
+
+git add .
+git commit -S -m "Post ${branch} cleanup"
+
+#---------------------------------------------------
+# Cleanup master
+echo -e "${BOLD}Cleanup the master branch${NORMAL}"
+git checkout master
+git merge ${branch}
+git push origin master
+#git push UPSTREAM master
+
+#---------------------------------------------------
+# Cleanup develop
+echo -e "${BOLD}Cleanup the develop branch${NORMAL}"
+git checkout develop
+git merge ${branch}
+git push origin develop
+#git push UPSTREAM develop
+
+# keep or delete the release branch? up to you
+# at this point, you should have uptodate develop and master,
+# as well as the release and post-release branches
+
+#---------------------------------------------------
+# Phew!
+
+echo -e "${BOLD}Congratulations - we have liftoff${NORMAL}"
+echo "Don't forget to announce this release on the forum and on twitter!"