Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sandrokeil/htmlelement

Zend Framework view helper plugin to use html tags like objects and to render them.
https://github.com/sandrokeil/htmlelement

html html-element php php7 zend

Last synced: about 2 months ago
JSON representation

Zend Framework view helper plugin to use html tags like objects and to render them.

Awesome Lists containing this project

README

        

# USING THE GIT REPOSITORY

## Setup your own public github repository

Your first step is to establish a public repository from which i can pull your work into the master repository.

1. Setup a GitHub account (http://github.com/), if you haven't yet
2. Fork the HtmlElement repository (http://github.com/sandrokeil/HtmlElement)
3. Clone your fork locally and enter it (use your own GitHub username in the statement below)

```sh
% git clone [email protected]:/HtmlElement.git
% cd HtmlElement
```

4. Add a remote to the canonical HtmlElement repository, so you can keep your fork
up-to-date:

```sh
% git remote add upstream https://github.com/sandrokeil/HtmlElement.git
% git fetch upstream
```

## Keeping Up-to-Date

Periodically, you should update your fork to match the canonical HtmlElement repository. we have
added a remote to the HtmlElement repository, which allows you to do the following:

```sh
% git checkout master
% git pull upstream master
- OPTIONALLY, to keep your remote up-to-date -
% git push origin
```

If you're tracking other branches -- for example, the "develop" branch, where new feature development occurs --
you'll want to do the same operations for that branch; simply substitute "develop" for "master".

## Working on HtmlElement

When working on HtmlElement, we recommend you do each new feature or bugfix in a new branch. This simplifies the
task of code review as well as of merging your changes into the canonical repository.

A typical work flow will then consist of the following:

1. Create a new local branch based off your master branch.
2. Switch to your new local branch. (This step can be combined with the previous step with the use of `git checkout -b`.)
3. Do some work, commit, repeat as necessary.
4. Push the local branch to your remote repository.
5. Send a pull request.

The mechanics of this process are actually quite trivial. Below, we will create a branch for fixing an issue in the tracker.

```sh
% git checkout -b 3452
Switched to a new branch '3452'
```
... do some work ...

```sh
% git commit
```
... write your log message ...

```sh
% git push origin HEAD:3452
Counting objects: 38, done.
Delta compression using up to 2 threads.
Compression objects: 100% (18/18), done.
Writing objects: 100% (20/20), 8.19KiB, done.
Total 20 (delta 12), reused 0 (delta 0)
To ssh://[email protected]/sandrokeil/HtmlElement.git
g5342..9k3532 HEAD -> master
```

You can do the pull request from github. Navigate to your repository, select the branch you just created, and then
select the "Pull Request" button in the upper right. Select the user "sandrokeil" as the recipient.

### What branch to issue the pull request against?

Which branch should you issue a pull request against?

- For fixes against the stable release, issue the pull request against the "master" branch.
- For new features, or fixes that introduce new elements to the public API
(such as new public methods or properties), issue the pull request against the "develop" branch.

## Branch Cleanup

As you might imagine, if you are a frequent contributor, you'll start to get a ton of branches both locally and on
your remote.

Once you know that your changes have been accepted to the master repository, we suggest doing some cleanup of these
branches.

- Local branch cleanup

```sh
% git branch -d
```

- Remote branch removal

```sh
% git push origin :
```

## FEEDS AND EMAILS

RSS feeds may be found at:

`https://github.com/sandrokeil/HtmlElement/commits/.atom`

where <branch> is a branch in the repository.

To subscribe to git email notifications, simply watch or fork the HtmlElement repository on GitHub.