Thank you for contributing! 🌟
By contributing to Ghost storage adapter S3, you agree to abide by the code of conduct.
Please open an issue for discussion before you spend the time to submit a pull request.
- Fork this repository
- Clone your fork:
git clone [email protected]:your-username/ghost-storage-adapter-s3.git && cd ghost-storage-adapter-s3 - Install the dependencies:
npm install
You should now be able to use the npm scripts to carry out some useful tasks:
npm run buildnpm run commit
For a full list checkout the
package.json file.
Your master branch should be kept clean and you should create a new branch for each pull request.
git remote add upstream [email protected]:colinmeinke/ghost-storage-adapter-s3.git
git checkout -b my-branch-name
Once you've made your changes you'll need to commit.
We use semantic release for releasing this module to npm, and generating changelogs.
Semantic release relies upon commit message syntax, therefore commit messages are important.
We use Angular's commit message conventions.
Running npm run commit will guide you through the process.
git checkout master
git pull upstream master
git checkout my-branch-name
git rebase master
git push -u origin my-branch-name
Sometimes new commits will be made to Ghost storage adapter S3 whilst you're waiting for your pull request to be merged.
In this case your pull request will need some extra work so it can be cleanly merged.
- Fetch changes from master
- Rebase your changes
- Force push (carefully!):
git push -f origin my-branch-name