Skip to content

Contributing

Huston Hedinger edited this page May 6, 2014 · 5 revisions

Somethings to Know

Alchemy uses Yeoman.io to manage workflow, and they have fantastic documentation to easily get up and running.

If you are familiar with Yeoman already, it will be helpful to know how Alchemy's grunt tasks are configured. The main grunt task, build, wether being used in developmment or to build the dist does the following:

  • Copies all coffee script files into .tmp directory
  • Concats all of the coffee script files with the start.coffee at the beginning and the end.coffee file at the end

In development, there is a alchemy.src.coffee file in the .tmp directory, making it easy to use mapping files to debug the coffeescript directly.

Overriding Default Functions

Including Your Code

We'd love to include that awesome new feature you've built. Here is the process:

  • Fork this repo
  • git clone <my_fork_of_this_repo>
  • git checkout -b <my_awesome_new_feature>
  • git branch -D master

When you feel like your contribution is battle ready, feel free to submit a pull request. We may have come conversations about pieces of it, or we may merge it right away.

Ahead of us merging your code, you will will need to have signed our contributor agreement. It is pretty minor, feel free to reach out if you have questions.

Clone this wiki locally