# Contributing to Lyricli

At this moment this is a really small project that I used to revive an
old ruby project and learn swift, it probably has a lot of bad code that
is not in "the swift way", it has no tests and can always be extended to
support more sources.

## The ~~Roadmap~~ ~~Streetmap~~ ~~Pathmap~~ Corridormap

* Writing sources (They're used to automatically obtain artist and song
  name from apps or services)
* Writing tests
* Improving code to match idiomatic swift
* Improving the documentation
* Extending the lyrics engine to support different lyrics sources
* Improving the build system

## How to contribute

Be nice, always, to others and yourself: use welcoming and inclusive language,
be patient and respectful of others' opinions and experiences.

Do not insult others, use sexualized language, publish others' personal
information without their consent. Do not harass others.

To report unacceptabe behavior, send an [e-mail][email]

## Sending Pull Requests

* Run [swiftlint][swiftlint] on the Source directory and make sure there are no errors
* There should be no warnings on compilation
* [CI][ci] should be green
* Make the PRs according to [Git Flow][gitflow]: (features go to
  develop, hotfixes go to master)

[gitflow]: https://github.com/nvie/gitflow
[swiftlint]: https://github.com/realm/SwiftLint
[email]: mailto:ben@nsovocal.com
[ci]: https://travis-ci.org/lyricli-app/lyricli