Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
137 lines (94 loc) · 3.9 KB

CONTRIBUTING.md

File metadata and controls

137 lines (94 loc) · 3.9 KB

Contributing

Hey there, thanks for wanting to contribute the Theme Pattern Library - you rock!

Creating an issue

If you find a bug or would like something added to the library, then creating an issue is a great starting place. Here is a good process for creating an issue:

  1. Search first to ensure this hasn't already been reported.
  2. Create an issue. If a bug, ensure someone can recreate it. A video works really well to show people. If an enhancement then a mockup, showing example or sketch helps.
  3. PR what is even better than an issue is an issue with a PR already attached. If you have found a bug and can fix it, then attach a PR to your issue.

Feature requests

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.

Pull requests

Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please adhere to the coding conventions used throughout a project (indentation, accurate comments, etc.) and any other requirements (such as test coverage).

Follow this process if you'd like your work considered for inclusion in the project:

  1. Fork the project, clone your fork, and configure the remotes:

    # Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/slush-slush-theme-pattern-library
# Navigate to the newly cloned directory
cd slush-slush-theme-pattern-library
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/danielrobert/slush-slush-theme-pattern-library

  2. If you cloned a while ago, get the latest changes from upstream:

    git checkout <dev-branch>
git pull upstream <dev-branch>

  3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:

    git checkout -b <topic-branch-name>

  4. Commit your changes in logical chunks. Please adhere to these git commit message guidelines or your code is unlikely be merged into the main project. Use Git's interactive rebase feature to tidy up your commits before making them public.

  5. Locally merge (or rebase) the upstream development branch into your topic branch:

    git pull [--rebase] upstream <dev-branch>

  6. Push your topic branch up to your fork:

    git push origin <topic-branch-name>

  7. Open a Pull Request with a clear title and description.

Conventions of commit messages

Addding files on repo

git commit -m "Add filename"

Updating files on repo

git commit -m "Update filename, filename2, filename3"

Removing files on repo

git commit -m "Remove filename"

Renaming files on repo

git commit -m "Rename filename"

Fixing errors and issues on repo

git commit -m "Fixed #issuenumber Message about this fix"

Adding features on repo

git commit -m "Add Feature: nameoffeature Message about this feature"

Updating features on repo

git commit -m "Update Feature: nameoffeature Message about this update"

Removing features on repo

git commit -m "Remove Feature: nameoffeature Message about this"

Ignoring Travis CI build on repo

git commit -m "Commit message here [ci-skip]"

IMPORTANT: By submitting a patch, you agree to allow the project owner to license your work under the same license as that used by the project.