gerryfort / skeletal Goto Github PK

Skeletal is the development theme for Neto. This theme contains all of our supported front-end features, so we build all new custom websites and themes with Skeletal as the starting point. Skeletal is built on Bootstrap 3.

The safest way to install Skeletal is through Neto's theme store. Go to Webstore > Theme editor in your Neto control panel, hover over Skeletal and click the green Install button.

To install the latest version of Skeletal directly from this repository you simply need to upload the src directory from this repository into the httpdocs/assets/themes directory on your website. You should also rename this new src directory to whatever you would like your custom theme to be named.

For the above, you will need FTP access to your Neto website, which you can request here.

Documentation for designers and developers can be found here.

As Skeletal is built almost entirely upon Bootstrap 3, the Bootstrap documentation is perhaps the most valuable source of documentation for a web designer who isn't looking to build complex functionality.

If you are not comfortable working with LESS, you are best off writing all CSS in your own custom CSS file. As our .less files are compiled into app.css, avoid modifying app.css. Otherwise, if for whatever reason you eventually do need to re-compile the less files, any changes to app.css would be lost.

If you are comfortable with Less, you're best off developing in you're own less file and adding it to the imports in src/css/app.less, which needs to be compiled to src/css/app.css using Gulp.

If you are compiling .less files for the purpose of contributing to Skeletal, follow these steps:

Note that steps 1 and 2 only need to be completed once per system, so no need to repeat them again.

1. Install node.js
2. Install Gulp globally with npm install --global gulp in your terminal, if you have not already
3. CD into your local folder for Skeletal and run the npm install command to install all relevant dependencies
4. Run gulp—this will now watch your .less files and compile them as they change

We have a simple testing guide located here.

Have you found an issue on Skeletal but don't know exactly how to fix it? Raise an issue:

• https://github.com/NetoECommerce/Skeletal/issues

Do you know a fix for a current Skeletal issue? Do you know an enhancement that could be used on Skeletal? Make a pull request with your new code!

You want to download the latest version of Skeletal so your local version is up to date with the remote:

git clone https://github.com/NetoECommerce/Skeletal.git

If you already have a local version of Skeletal then you just need to update it to match the remote:

git pull

You do not want your changes to be on master, changes need to be reviewed to ensure it meets Neto standards and you could possible have made mistakes. You make a branch off the master branch so you have all the latest commits and can safely make changes without affecting live code.

git checkout -b "BRANCH-NAME"

Branching name should be prefixed with how the pull request is helping Skeletal. Is this pull request fixing a bug?

git checkout -b "hotfix/branch-title"

Is this pull request adding a new feature or enhancement?

git checkout -b "feature/branch-title"

Is there an associated issue on the repo?

git checkout -b "issue-number/branch-title"

Try to ensure your commit messages are frequent and descriptive. A commit should encompass one change, e.g redesigning home page and adding new pricing logic for product page would be two different commits. the home page redesign might have multiple template changes but it doesn't have anything to do with the pricing logic change on the product page.

git add -A

git commit -m "commit message"

When your branch is completed and ready for review you can submit a pull request. If you haven't already, push your branch up to the remote:

git push

You might need to set you the branch to be tracked as it is a new branch you made locally:

git push -u origin "BRANCH-NAME"

A pull request will need a description on what it is trying to achieve with this change and if possible, steps on how to view changes on a Neto site. This is neccessary as someone else will be reviewing your pull request and can't be expected to understand what it is doing/fixing just by reviewing the code.

The person making the pull request will have left a description on what it is trying to achieve and how to reproduce it yourself.

This might be as simple as a style change and listing out where you can view this, or it might be some template/logic changes which require a few steps to reproduce. If it is unclear how to view the pull requests changes, please get in contact with the person that made the pull request.

You should be able to view a working example of the changes on your Neto dev site based on the pull request description.

Ensure you have the most up to date version of the Skeletal master repo, then switch to the pull requests branch:

git checkout "PULL-REQUEST-BRANCH"

Then ensure you have the most up to date commits:

git pull

Please Note: This is one of the reasons users should do a branch instead of a fork. When you fork a repo, it makes a copy of the repo but under your users account, e.g If I forked Skeletal it work be in my repos instead of NetoECommerce. This makes it difficult to review as it no longer can be checked out while in the NetoECommerce/Skeletal repo.

Open up the .git/config file and add a new line under [remote "origin"]:

fetch = +refs/pull/*/head:refs/pull/origin/*

Now you can fetch and checkout any pull request so that you can test them:

# Fetch all pull request branches
git fetch origin

# Checkout out a given pull request branch based on its number
git checkout pull/origin/999

Keep in mind that these branches will be read only and you won't be able to push any changes. Branch name will be pull/origin/PULL_REQUEST_NUMBER.

When you have the pull request branch locally, push it into the theme directory to view the changes on your Neto dev site.

/httpdocs/assets/themes/THEME-NAME

?nview=THEME-NAME

After you have reviewed the pull request, add in your review:

• Comment: General feedback but not explicit approval
• Approval: Submit feedback and approve merging these changes into the master branch

If a pull requested is approval then an admin user will be notified and will be able to merge the branch into master.

• Request feedback: Submit feedback that must be addressed before the branch can be merged into master.

The person that submitted the pull request will be notified on your feedback and will address the issues before requesting the branch to be reviewed again.

The current version of Skeletal will only work on websites running Neto 6+. For older websites, you will need to install from a previous release.

Skeletal was created by the design team at Neto E-commerce Solutions.