parent
d5bcf67057
commit
875bf29c31
1 changed files with 51 additions and 0 deletions
@ -0,0 +1,51 @@ |
||||
# Contributing |
||||
|
||||
## Pull Requests |
||||
|
||||
1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork, |
||||
and configure the remotes: |
||||
|
||||
```bash |
||||
# 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: |
||||
|
||||
```bash |
||||
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: |
||||
|
||||
```bash |
||||
git checkout -b <topic-branch-name> |
||||
``` |
||||
|
||||
4. Commit your changes in logical chunks. Please adhere to these [git commit |
||||
message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) |
||||
or your code is unlikely be merged into the main project. Use Git's |
||||
[interactive rebase](https://help.github.com/articles/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: |
||||
|
||||
```bash |
||||
git pull [--rebase] upstream master |
||||
``` |
||||
|
||||
6. Push your topic branch up to your fork: |
||||
|
||||
```bash |
||||
git push origin <topic-branch-name> |
||||
``` |
||||
|
||||
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) |
||||
with a clear title and description against the `master` branch. |
Loading…
Reference in new issue