Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
77 lines (48 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

77 lines (48 loc) · 2.75 KB

Contributing

Thanks for considering contributing to Big Ideas Text!

Opening issues

If you find a bug, please feel free to open an issue.

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!

Run Big Ideas Text locally

To get started locally, run these commands:

git clone https://github.com/kennethormandy/big-ideas-text
npm install
npm start

Configuring Grunt

You should’t really need to use the Grunt commands directly if you don’t want; npm install, npm start, and npm test should be sufficient.

If you want to dig into it, the Grunt setup is entirely from BigText. @zackleat writes:

Rather than one giant Gruntfile.js, this project is using a modular Grunt setup. Each individual grunt configuration option key has its own file located in grunt/config-lib/ (readonly upstream configs, do not modify these directly) or grunt/config/ (project specific configs). You may use the same key in both directories, the objects are smartly combined using Lo-Dash merge. For concatenation in the previous Gruntfile setup, you’d add another key to the giant object passed into grunt.initConfig like this: grunt.initConfig({ concat: { /* YOUR CONFIG */ } });. In the new configuration, you’ll create a grunt/config/concat.js with module.exports = { /* YOUR CONFIG */ };.

Fixing bugs

We love pull requests. Here’s a quick guide:

  1. Fork this repository and then clone it locally:
git clone https://github.com/kennethormandy/big-ideas-text
  1. Create a topic branch for your changes. I like to preface my branches with my initials:
git checkout -b ko-fix-for-that-thing
  1. Commit a failing test for the bug:
git commit -am "Adds a failing test to demonstrate that thing"
  1. Commit a fix that makes the test pass:
git commit -am "Adds a fix for that thing!"
  1. Run the tests:
npm test
  1. If everything looks good, push to your fork:
git push origin fix-for-that-thing

  1. Submit a pull request.

  2. Enjoy being the wonderful person you are

After you’ve opened your pull request, you should email me your mailing address so I can mail you a personal thank you note. Seriously!

Adding new features

Thinking of adding a new feature? Cool! Open an issue and let’s design it together.