git.r.bdr.sh - rbdr/lyricli/blob - CONTRIBUTING.md

   1 # Contributing to Lyricli
   2
   3 At this moment this is a really small project that I used to revive an
   4 old ruby project and learn swift, it probably has a lot of bad code that
   5 is not in "the swift way", it has no tests and can always be extended to
   6 support more sources.
   7
   8 ## The ~~Roadmap~~ ~~Streetmap~~ ~~Pathmap~~ Corridormap
   9
  10 * Writing sources (They're used to automatically obtain artist and song
  11   name from apps or services)
  12 * Writing tests
  13 * Improving code to match idiomatic swift
  14 * Improving the documentation
  15 * Extending the lyrics engine to support different lyrics sources
  16 * Improving the build system
  17
  18 ## How to contribute
  19
  20 Be nice, always, to others and yourself: use welcoming and inclusive language,
  21 be patient and respectful of others' opinions and experiences.
  22
  23 Do not insult others, use sexualized language, publish others' personal
  24 information without their consent. Do not harass others.
  25
  26 To report unacceptabe behavior, send an [e-mail][email]
  27
  28 ## Sending Pull Requests
  29
  30 * Run [swiftlint][swiftlint] on the Source directory and make sure there are no errors
  31 * There should be no warnings on compilation
  32 * [CI][ci] should be green
  33 * Make the PRs according to [Git Flow][gitflow]: (features go to
  34   develop, hotfixes go to master)
  35
  36 [gitflow]: https://github.com/nvie/gitflow
  37 [swiftlint]: https://github.com/realm/SwiftLint
  38 [email]: mailto:ben@nsovocal.com
  39 [ci]: https://travis-ci.org/lyricli-app/lyricli