From 9008247d8e0c5a7f0299cdc240e7b3d87c8aace5 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Sun, 8 Jul 2018 15:35:16 -0400 Subject: [PATCH 1/4] docs: Adding a Contribute file --- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5c49594 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +# Contributing + +Source hosted at [GitHub](http://github.com/splitrb/split-api). +Report Issues/Feature requests on [GitHub Issues](http://github.com/splitrb/split-api/issues). + +Tests can be ran with `rake spec` + +Please conform to the [Code of Conduct](CODE_OF_CONDUCT.md). + +## Note on Patches/Pull Requests + + * Fork the project. + * Make your feature addition or bug fix. + * Add tests for it. This is important so I don't break it in a + future version unintentionally. + * Commit, do not mess with rakefile, version, or history. + (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull) + * Send me a pull request. Bonus points for topic branches. From 51e9e97f990b07afd3c747431f3be27baae69f34 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Sun, 8 Jul 2018 15:35:46 -0400 Subject: [PATCH 2/4] docs: Extending license year --- LICENSE | 2 +- Readme.mdown | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/LICENSE b/LICENSE index 7fd5270..b2ebfbe 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2013 Andrew Nesbitt +Copyright (c) 2013-2018 Andrew Nesbitt Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the diff --git a/Readme.mdown b/Readme.mdown index 5dfc668..17522a2 100644 --- a/Readme.mdown +++ b/Readme.mdown @@ -39,6 +39,6 @@ Tests can be ran with `rake spec` (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull) * Send me a pull request. Bonus points for topic branches. -## Copyright +## License -Copyright (c) 2013 Andrew Nesbitt. See LICENSE for details. \ No newline at end of file +Copyright (c) 2013-2018 Andrew Nesbitt. See [LICENSE](LICENSE) for details. \ No newline at end of file From 88c8a7150be645a3ac4f15cdc0e6e59a03d294d3 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Sun, 8 Jul 2018 15:35:59 -0400 Subject: [PATCH 3/4] docs: Slight formatting edits --- Readme.mdown | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/Readme.mdown b/Readme.mdown index 17522a2..cd256e1 100644 --- a/Readme.mdown +++ b/Readme.mdown @@ -1,12 +1,14 @@ -# Split::Api +# Split::API -An extension to [Split](http://github.com/splitrb/split) to provide a REST-based JSON api. +An extension to [Split](http://github.com/splitrb/split) to provide a REST-based JSON API. -## Requirements +## Install + +### Requirements The split gem and its dependencies. -## Setup +### Setup gem install split-api @@ -22,13 +24,15 @@ Javascript library for communicating with api *note to be added about sharing sessions between apps* -## Development +## Contributing Source hosted at [GitHub](http://github.com/splitrb/split-api). Report Issues/Feature requests on [GitHub Issues](http://github.com/splitrb/split-api/issues). Tests can be ran with `rake spec` +Please conform to the [Code of Conduct](CODE_OF_CONDUCT.md). + ### Note on Patches/Pull Requests * Fork the project. From 829f3abc00c2e07c6b95d977b3962b4112925d15 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Sun, 8 Jul 2018 15:36:08 -0400 Subject: [PATCH 4/4] docs: Adding a bug_tracker_uri field --- split-api.gemspec | 1 + 1 file changed, 1 insertion(+) diff --git a/split-api.gemspec b/split-api.gemspec index 13725b8..3f67536 100644 --- a/split-api.gemspec +++ b/split-api.gemspec @@ -6,6 +6,7 @@ Gem::Specification.new do |gem| gem.email = ["andrewnez@gmail.com"] gem.summary = %q{Rest API extension for Split} gem.homepage = 'http://github.com/splitrb/split-api' + gem.bug_tracker_uri = 'http://github.com/splitrb/split-api/issues' gem.license = 'MIT' gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }