How to Git

1.md

Contribute to Skeletal

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 have an enhancement to Skeletal?

• Make a Pull Request with your new code:

Clone latest version of Skeletal

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

Make a new branch

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 effectly live code.

git checkout -b "BRANCH-NAME"

Naming branch

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"

Make changes and comment

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"

Submit a pull request

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.

2.md

Review a pull request

Read pull request description

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.

Test out code on dev site and do a code review

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.

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

Comment on findings

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.

If it is unclear how to view the pull requests changes, please get in contact with the person that made the pull request.

Should this be left as a comment on the PR?

Push your local branch into the theme directory to view the changes.

Missing the step of how to get the specific branch clone to replicate the changes.