Skip to content

Commit 72f278c

Browse files
committed
Add thoughtbot documents
* Mentions thoughtbot in README.md and LICENSE.txt * Change `.gemspec` to point to new repository URL * Adds a RELEASING.md to document how to release the project * Adds a CONTRIBUTING.md to document how to contribute to the project
1 parent bb34d56 commit 72f278c

File tree

5 files changed

+82
-7
lines changed

5 files changed

+82
-7
lines changed

CONTRIBUTING.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Contributing
2+
3+
We love pull requests from everyone.
4+
By participating in this project,
5+
you agree to abide by the thoughtbot [code of conduct].
6+
7+
[code of conduct]: https://thoughtbot.com/open-source-code-of-conduct
8+
9+
We expect everyone to follow the code of conduct
10+
anywhere in thoughtbot's project codebases,
11+
issue trackers, chatrooms, and mailing lists.
12+
13+
$ bundle install
14+
15+
Fork the repo.
16+
17+
Make sure the tests pass:
18+
19+
$ bundle exec rake
20+
21+
Make your change, with new passing tests. Follow the [style guide][style].
22+
23+
[style]: https://github.com/thoughtbot/guides/tree/master/style
24+
25+
Push to your fork. Write a [good commit message][commit]. Submit a pull request.
26+
27+
[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
28+
29+
Others will give constructive feedback.
30+
This is a time for discussion and improvements,
31+
and making the necessary changes will be required before we can
32+
merge the contribution.

LICENSE.txt

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
Copyright (c) 2015 Sean Doyle and thoughtbot, inc.
12
Copyright (c) 2014 Pavel Pravosud
23

34
MIT License

README.md

+28-6
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ Your Ember application will now be served at the `/` route.
124124

125125
### Other routes
126126

127-
Rendering Ember applications at routes other than `/` requires additional setup to avoid an Ember `UnrecognizedURLError`.
127+
Rendering Ember applications at routes other than `/` requires additional setup to avoid an Ember `UnrecognizedURLError`.
128128

129129
For instance, if you had Ember applications named `:frontend` and `:admin_panel` and you wanted to serve them at `/frontend` and `/admin_panel`, you would set up the following Rails routes:
130130

@@ -396,8 +396,30 @@ jQuery and Handlebars are the main use cases for this flag.
396396

397397
## Contributing
398398

399-
1. Fork it (https://github.com/rwz/ember-cli-rails/fork)
400-
2. Create your feature branch (`git checkout -b my-new-feature`)
401-
3. Commit your changes (`git commit -am 'Add some feature'`)
402-
4. Push to the branch (`git push origin my-new-feature`)
403-
5. Create a new Pull Request
399+
See the [CONTRIBUTING] document.
400+
Thank you, [contributors]!
401+
402+
[CONTRIBUTING]: CONTRIBUTING.md
403+
[contributors]: https://github.com/thoughtbot/ember-cli-rails/graphs/contributors
404+
405+
## License
406+
407+
Open source templates are Copyright (c) 2015 thoughtbot, inc.
408+
It contains free software that may be redistributed
409+
under the terms specified in the [LICENSE] file.
410+
411+
[LICENSE]: /LICENSE.txt
412+
413+
## About
414+
415+
![thoughtbot](https://thoughtbot.com/logo.png)
416+
417+
Templates are maintained and funded by thoughtbot, inc.
418+
The names and logos for thoughtbot are trademarks of thoughtbot, inc.
419+
420+
We love open source software!
421+
See [our other projects][community]
422+
or [hire us][hire] to help build your product.
423+
424+
[community]: https://thoughtbot.com/community?utm_source=github
425+
[hire]: https://thoughtbot.com/hire-us?utm_source=github

RELEASING.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Releasing
2+
3+
1. Update version file accordingly.
4+
1. Update `CHANGELOG.md` to reflect the changes since last release.
5+
1. Commit changes.
6+
There shouldn't be code changes,
7+
and thus CI doesn't need to run,
8+
you can then add "[ci skip]" to the commit message.
9+
1. Tag the release: `git tag vVERSION`
10+
1. Push changes: `git push --tags`
11+
1. Build and publish:
12+
13+
```bash
14+
gem build ember-cli-rails.gemspec
15+
gem push ember-cli-rails-*.gem
16+
```
17+
18+
1. Announce the new release,
19+
making sure to say "thank you" to the contributors
20+
who helped shape this version!

ember-cli-rails.gemspec

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
66
spec.authors = ["Pavel Pravosud", "Jonathan Jackson", "Sean Doyle"]
77
88
spec.summary = "Integration between Ember CLI and Rails"
9-
spec.homepage = "https://github.com/rwz/ember-cli-rails"
9+
spec.homepage = "https://github.com/thoughtbot/ember-cli-rails"
1010
spec.license = "MIT"
1111
spec.files = Dir["README.md", "CHANGELOG.md", "LICENSE.txt", "{lib,app,config}/**/*"]
1212

0 commit comments

Comments
 (0)