Skip to content

Latest commit

 

History

History
51 lines (38 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

51 lines (38 loc) · 1.71 KB
Raw

Contributing

Pull Requests

  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>/svelte-storybook-tailwind.git
# Navigate to the newly cloned directory
cd svelte-storybook-tailwind
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/jerriclynsjohn/svelte-storybook-tailwind.git

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

    git checkout master
git pull upstream master

  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. Also, prepend name of the feature to the commit message. For instance: "Svelte: Fixes compiler results for PostCSS.\nFixes #123"

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

    git pull [--rebase] upstream master

  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 against the master branch.