Thanks for considering contributing to the Grunt plugin for Surge.
Feel free to send Kenneth an email or open an issue here if you have questions about Surge, contributing this project, or anything else related. Otherwise, here’s the general process we like to use to maintain the project:
If you find a bug, we’ll really appreciate it if you open an issue with as many details as possible. The easier you make it for us to recreate the issue we found, the faster we can move onto trying to fix it.
If you taking the time to mention a problem, even a seemingly minor one, it is greatly appreciated, and a totally valid contribution to this project. Thank you!
We love pull requests. Here’s a quick guide:
- Fork this repository and then clone it locally:
git clone https://github.com/chloi/grunt-surge- Create a topic branch for your changes:
git checkout -b fix-for-that-thing- Commit a failing test for the bug:
git commit -am "Adds a failing test to demonstrate that thing"- Commit a fix that makes the test pass:
git commit -am "Adds a fix for that thing!"- Run the tests:
npm test- If everything looks good, push to your fork:
git push origin fix-for-that-thing-
Enjoy being the wonderful person you are
After you’ve opened your pull request, if you’d like, send us an email with your work mailing address. We’ll send you a thank-you note and some stickers!
Thinking of adding a new feature? Cool! Open an issue and let’s design it together. We’re very open to collaborating, and like to make sure that we’ll be able to merge your work before you have to put a lot of time into it.