Skip to content

Commit

Permalink
Rewrite contributing, new issue template, update archive excluded fil…
Browse files Browse the repository at this point in the history
…es, composer.json, travis.yml,
  • Loading branch information
sampoyigi committed Oct 18, 2017
1 parent 0d8b33c commit 3c451b0
Show file tree
Hide file tree
Showing 7 changed files with 127 additions and 720 deletions.
8 changes: 7 additions & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,10 @@ text=auto

# Ignore files when exporting
.gitattributes export-ignore
.gitignore export-ignore
.gitignore export-ignore
.travis.yml export-ignore
CHANGELOG.md export-ignore
CONTRIBUTING.md export-ignore
ISSUE_TEMPLATE.md export-ignore
phpunit.xml export-ignore
server.php export-ignore
37 changes: 6 additions & 31 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,36 +1,11 @@
.DS_Store
.idea
.htaccess
.env

admin/cache/*
!admin/cache/index.html
!admin/cache/.htaccess

assets/images/captcha/*
!assets/images/captcha/index.html

assets/images/thumbs/*
!assets/images/thumbs/index.html

assets/images/data/*
!assets/images/data/index.html
!assets/images/data/no_photo.png
!assets/images/data/flags

assets/downloads/*
!assets/downloads/index.html

main/cache/*
!main/cache/index.html
!main/cache/.htaccess

system/tastyigniter/logs/*
!system/tastyigniter/logs/index.html

system/tastyigniter/session/*
!system/tastyigniter/session/index.html

system/tastyigniter/migrations/backups/*
!system/tastyigniter/migrations/backups/index.html
/extensions/*
!/extensions/demo

# Ignore all vendor files included by composer and the lock file
/vendor/*
/vendor
composer.lock
14 changes: 14 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
language: php

# list of PHP version to test against
php:
- 7.0
- 7.1
- hhvm

sudo: false

# build only the specified branches
branches:
only:
- master
43 changes: 32 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,46 @@ Issues are a quick way to point out a bug. If you find a bug in TastyIgniter the
3. The issue has already been fixed (check the develop branch, or look for closed Issues)
4. Is it something really obvious that you can fix yourself?

Reporting issues is helpful but an even better approach is to send a Pull Request, which is done by "Forking" the main repository and committing to your own copy. This will require you to use the version control system called Git.
We work hard to process bugs that are reported, to assist with this please ensure the following details are always included:
- Bug summary: Make sure your summary reflects what the problem is and where it is.
- Reproduce steps: Clearly mention the steps to reproduce the bug.
- Version number: The TastyIgniter version affected.
- Expected behavior: How TastyIgniter 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.

Please be very clear on your commit messages and pull request, empty pull request messages may be rejected without reason.

All code must meet the [TastyIgniter coding standards](). This makes certain that all code follow the same format as the existing code and means it will be as readable as possible.
### Reporting security issues

If you change anything that requires a change to documentation then you will need to add it. New classes, methods, parameters, changing default values, etc are all things that will require a change to documentation. The change-log must also be updated for every change. Also PHPDoc blocks must be maintained.
If you wish to contact us privately about any security exploits in TastyIgniter you may find, you can find our email on the [TastyIgniter website](https://tastyigniter.com).

## Branching

TastyIgniter uses the [Git-Flow](http://nvie.com/posts/a-successful-git-branching-model/) branching model which requires all pull requests to be sent to the "develop" branch. This is where the next planned version will be developed. The "master" branch will always contain the latest stable version and is kept clean so a "hotfix" (e.g: an emergency security patch) can be applied to master to create a new version, without worrying about other features holding it up. For this reason all commits need to be made to "develop" and any sent to "master" will be closed automatically.

## Pull Requests

Your contributions to the TastyIgniter project are very welcome. If you would like to fix a bug or propose a new feature, you can submit a Pull Request.

### Branching
To help us merge your Pull Request, please make sure you follow these points:

TastyIgniter uses the [Git-Flow](http://nvie.com/posts/a-successful-git-branching-model/) branching model which requires all pull requests to be sent to the "develop" branch. This is where the next planned version will be developed. The "master" branch will always contain the latest stable version and is kept clean so a "hotfix" (e.g: an emergency security patch) can be applied to master to create a new version, without worrying about other features holding it up. For this reason all commits need to be made to "develop" and any sent to "master" will be closed automatically. If you have multiple changes to submit, please place all changes into their own branch on your fork.
1. Describe the problem clearly in the Pull Request description
2. Please make your fix on the develop branch. As explained above.
3. For any change that you make, please try to also add a test case(s) in the tests/unit directory. This helps us understand the issue and make sure that it will stay fixed forever.

## How to contribute
If you change anything that requires a change to documentation then you will need to add it. New classes, methods, parameters, changing default values, etc are all things that will require a change to documentation. The change-log must also be updated for every change. Also PHPDoc blocks must be maintained.

All code must meet the PSR Coding standards. This makes certain that all code follow the same format as the existing code and means it will be as readable as possible.

- [PSR 2 Coding Style Guide](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)
- [PSR 1 Coding Style Guide](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md)
- [PSR 0 Coding Style Guide](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md)

There are two ways to make changes, the easy way and the hard way. Either way you will need to [create a GitHub account](https://github.com/signup/free).
### How to contribute

Easy way GitHub allows in-line editing of files for making simple typo changes and quick-fixes. This is not the best way as you are unable to test the code works. If you do this you could be introducing syntax errors, etc, but for a Git-phobic user this is good for a quick-fix.
**DO NOT** use GitHub in-line editing to make changes as this could introduce syntax errors, etc, please "clone" instead.

Hard way The best way to contribute is to "clone" your fork of TastyIgniter to your development area. That sounds like some jargon, but "forking" on GitHub means "making a copy of that repo to your account" and "cloning" means "copying that code to your environment so you can work on it".
First, you will need to [create a GitHub account](https://github.com/signup/free), if you don't already have one.

1. Set up Git (Windows, Mac & Linux)
2. Go to the TastyIgniter repo
Expand All @@ -45,9 +66,9 @@ If your change fails to meet the guidelines it will be bounced, or feedback will

If not it will be merged into develop and your patch will be part of the next release.

### Keeping your fork up-to-date
##### Thanks for contributing.

Unlike systems like Subversion, Git can have multiple remotes. A remote is the name for a URL of a Git repository. By default your fork will have a remote named "origin" which points to your fork, but you can add another remote named "tastyigniter" which points to `git://github.com/tastyigniter/TastyIgniter.git`. This is a read-only remote but you can pull from this develop branch to update your own.
### Keeping your fork up-to-date

If you are using command-line you can do the following:

Expand Down
14 changes: 14 additions & 0 deletions ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
**Expected behavior:**
(Describe expected behavior here)

**Actual behavior:**
(Describe actual behavior here)

**Reproduce steps:**
(Describe the steps to reproduce the problem here)

**Version:**
(TastyIgniter version number)

**Additional Information:**
(Additional information, if any)
Loading

0 comments on commit 3c451b0

Please sign in to comment.