Skip to content

Latest commit

 

History

History
51 lines (34 loc) · 3.43 KB

contributing.md

File metadata and controls

51 lines (34 loc) · 3.43 KB
Raw

Contributing to Anchor

We're currently in the process of developing v1.0 but there are still issues to iron out with the existing distro: v0.9.x. So we've compiled this short document to help you guys help us!

First

  1. Find an issue that needs fixing, or create one if you've got a bug, don't worry, simply making us aware of bugs is a big help! Please follow these guidelines when submitting an issue.

Getting Anchor set up locally (If you haven't already)

  1. Fork anchor (use the button in the top right of the repo's page).
  2. git clone https://github.com/YOUR-USERNAME/anchor-cms to get a local copy of your fork.
  3. Run git remote add upstream https://github.com/anchor/anchor-cms. This will add another remote, named upstream, that points to the official Jeet repository. This will help with keeping your forks up to date with Anchor's master branch.

Making changes

  1. git checkout -b YourInitials/feature-branch-name (e.g. cs/improve-this-feature, ma/fix-this-bug). Make all your changes for the specific feature inside this branch.
  2. Separate edits into clean, non-breaking, commits.

Opening a pull request

  1. Push your changes to your fork by running git push origin your-branch-name.
  2. Open a pull request, give it a clear title and explain what your changes do. Even provide a code snippet if you can!
  3. Be prepared to update your PR based on feedback. If you make updates, run git push origin your-branch-name -f on your branch to update the PR on Github.

Keeping unmerged forks up to date with master

If your fork is taking a while to get merged, you might end up getting behind Anchor's dev branch as other changes get added. Stay up to date in the following way:

  1. git fetch upstream 0.9-dev This will give you all the latest updates from Anchor's dev branch.
  2. Run git rebase upstream/0.9-dev while inside your feature branch. This will add all the new commits before yours, so it's as if you made the changes to the latest codebase.

How to submit issues

Please follow the below points:

  • Check if bug is consistent in different environments
  • Check if its been reported and solved in the Anchor forum
  • Check if there is an issue that already covers or relates to it
  • Give an accurate and concise title to issue
  • Prefix title of issue with Bug: or Feature:
  • Explain bug briefly but in detail
  • Give guidance on how to reproduce bug
  • Add screenshots when possible

When writing your code, always follow standards

If you're familiar with open source software, you probably know how important coding guidelines and standards are. Most common are (in order of appearance) PEAR, Zend(Framework) and PSR-1/PSR-2.

Since the PHP-FIG and their standards gain more and more followers and Anchor uses composer, which supports PSR-0 and PSR-4, all code should follow PSR-1 and PSR-2. More help on best practices for PHP development can be found on PHP the right way.

When working on a file, always enforce coding standards for the whole file. This increases the consistency of the code with every contribution!