]> git.r.bdr.sh - rbdr/lyricli/blobdiff - CONTRIBUTING.md
Clean up files
[rbdr/lyricli] / CONTRIBUTING.md
index b91c725069de2e27b3f5197cc8c46890a5372536..7db059ac3df5243ac5d0a33335805eb53afb9683 100644 (file)
@@ -1,19 +1,8 @@
 # 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
+There is no particular direction planned for this project, but improving
+code quality, adding new sources, or the ability to use different lyrics
+engines would be welcome.
 
 ## How to contribute
 
@@ -25,15 +14,6 @@ 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)
+* Send patches to lyricli@r.bdr.sh using [git-send-mail][git-send-mail]
 
-[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
+[git-send-mail]: http://git-send-mail.io/