Skip to content

Latest commit

 

History

History
71 lines (56 loc) · 1.66 KB

CONTRIBUTING.md

File metadata and controls

71 lines (56 loc) · 1.66 KB
Raw

Contributing to baguetteBox.js

Please read these guidelines before contributing code.

🔩 Setting up the development environment

  • Fork and clone the repository
  • npm install
  • npm start
  • Demo page with live reload is available at localhost:3000

🐛 Fixing a Bug

When fixing a bug please make sure to test it on as many browsers as possible (see: Compatibility). If you are not able to do so, mention that in a PR comment, so other contributors can do it.

🎉 Proposing a Change

When implementing a feature please create an issue first explaining your idea and asking whether there's need for such a feature. Remember the script's core philosophy is to stay simple and minimal, doing one thing and doing it right.

📝 Before you open a Pull Request

  • Follow Git best practices (especially use meaningful commit messages).
  • Describe thoroughly you work in a PR comment.
  • Be patient and understanding. It's a side project, done in free time.

Thank you to everyone who has contributed to baguetteBox.js!

🚀 Releasing the next version

❗ This should be done only by core contributors ❗

Build the script

gulp build
git add --update
git commit -m "Build update"

Bump the version

gulp release # or gulp patch
git add --update
git commit -m "v1.8.0"

Push changes

git push

Merge master branch

git checkout master
git merge --ff-only dev

Add a tag

git tag v1.8.0
git push --follow-tags

Deploy the new demo page

gulp deploy
cd .publish
git push
cd ..

Publish the new version to npm

npm publish