Fork, then clone the repo:
git clone [email protected]:your-username/meta_commit.git
Set up your machine:
./bin/setup
Make sure the tests pass:
rake
Create your feature branch
git checkout -b my-new-feature
Make your change. Add tests for your change. Make the tests pass:
rake
Push to the branch
git push origin my-new-feature
Create a new Pull Request
Task of meta_commit gem is to :
- Walk over changes presented in commit
- Parse content of changes using parsers from extensions
- Find matching diffs for parsed changes
- Handle diffs (print as string, save to storage or return)
Extension is a gem that adds new parsers or diffs to core meta commit gem.
To be autoloaded by meta commit core it must follow agreements :
- Gem name matches
/^meta_commit_/regex - Gem has class with name
MetaCommit::Extension::#{ExtensionName}::Locator(ExtensionNamewithoutmeta_commit_prefix)- Which returns array of parser classes on
MetaCommit::Extension::#{ExtensionName}::Locator#parsers - Which returns array of diff classes on
MetaCommit::Extension::#{ExtensionName}::Locator#diffs
- Which returns array of parser classes on
Meta commit uses contracts to interact with extensions, you can check this contracts here.
To understand better how to build extension you can check extension that adds ruby language support.
By participating in this project, you agree to abide by the code of conduct.