backtop 1.0.0 → 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/CONTRIBUTING.md +63 -0
- data/MIT-LICENSE +1 -1
- data/README.md +6 -2
- data/lib/backtop/version.rb +1 -1
- metadata +2 -1
data/CONTRIBUTING.md
ADDED
@@ -0,0 +1,63 @@
|
|
1
|
+
## Found an Issue?
|
2
|
+
|
3
|
+
If you think you found a problem, we ask that you first run through these
|
4
|
+
debugging steps to make sure your environment is clean. The results of these
|
5
|
+
steps will also help us help you diagnose the issue.
|
6
|
+
|
7
|
+
1. Check out the latest master to make sure the feature hasn’t been implemented or the bug hasn’t been fixed yet.
|
8
|
+
|
9
|
+
2. Check out the issue tracker to make sure someone already hasn’t requested it and/or contributed it.
|
10
|
+
|
11
|
+
3. Fork the project.
|
12
|
+
|
13
|
+
4. Start a feature/hotfix branch.
|
14
|
+
|
15
|
+
5. Commit and push until you are happy with your contribution.
|
16
|
+
|
17
|
+
6. Make sure to add tests for it. This is important so I don’t break it in a future version unintentionally.
|
18
|
+
|
19
|
+
7. Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
|
20
|
+
|
21
|
+
## Want to Contribute?
|
22
|
+
|
23
|
+
Awesome. We love help, but before getting started, please read:
|
24
|
+
|
25
|
+
**[Don't "Push" Your Pull Requests](http://www.igvita.com/2011/12/19/dont-push-your-pull-requests/)**
|
26
|
+
|
27
|
+
## Ready for a Pull-Request?
|
28
|
+
|
29
|
+
1. Fork the repo.
|
30
|
+
|
31
|
+
2. Run the tests. We only take pull requests with passing tests, and it's great
|
32
|
+
to know that you have a clean slate: `bundle && bundle exec rake`
|
33
|
+
|
34
|
+
3. Add a test for your change. Only refactoring and documentation changes
|
35
|
+
require no new tests. If you are adding functionality or fixing a bug, we need
|
36
|
+
a test!
|
37
|
+
|
38
|
+
4. Make the test pass.
|
39
|
+
|
40
|
+
5. Push to your fork and submit a pull request.
|
41
|
+
|
42
|
+
At this point you're waiting on us. We like to at least comment on, if not
|
43
|
+
accept, pull requests within three business days (and, typically, one business
|
44
|
+
day). We may suggest some changes or improvements or alternatives.
|
45
|
+
|
46
|
+
Some things that will increase the chance that your pull request is accepted,
|
47
|
+
taken straight from the Ruby on Rails guide:
|
48
|
+
|
49
|
+
## Conventions
|
50
|
+
|
51
|
+
* Use Rails idioms and helpers.
|
52
|
+
* Include tests that fail without your code, and pass with your code.
|
53
|
+
* Update the documentation, the surrounding one, examples elsewhere, guides,
|
54
|
+
whatever is affected by your contribution
|
55
|
+
|
56
|
+
Syntax:
|
57
|
+
|
58
|
+
* Two spaces, no tabs.
|
59
|
+
* No trailing whitespace. Blank lines should not have any space.
|
60
|
+
* Prefer &&/|| over and/or.
|
61
|
+
* MyClass.my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
|
62
|
+
* a = b not a=b.
|
63
|
+
* Follow the conventions you see used in the source already.
|
data/MIT-LICENSE
CHANGED
data/README.md
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
# BackTop
|
1
|
+
# BackTop [![Gem Version](https://badge.fury.io/rb/backtop.png)](http://badge.fury.io/rb/backtop)
|
2
2
|
|
3
3
|
BackTop provides a back-to-top functionality for use with your rails application. It will append a back to top icon at the bottom right corner when user scrolls below the top fold.
|
4
4
|
|
@@ -39,4 +39,8 @@ In your `application.js`, include the js file:
|
|
39
39
|
|
40
40
|
Then restart your webserver if it was previously running.
|
41
41
|
|
42
|
-
Congrats! You now have back to top functionality in your app.
|
42
|
+
Congrats! You now have back to top functionality in your app.
|
43
|
+
|
44
|
+
## Copyright
|
45
|
+
|
46
|
+
BackTop is licensed under the [MIT License](http://opensource.org/licenses/mit-license.html)
|
data/lib/backtop/version.rb
CHANGED
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: backtop
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.0.
|
4
|
+
version: 1.0.1
|
5
5
|
prerelease:
|
6
6
|
platform: ruby
|
7
7
|
authors:
|
@@ -131,6 +131,7 @@ extensions: []
|
|
131
131
|
extra_rdoc_files: []
|
132
132
|
files:
|
133
133
|
- .gitignore
|
134
|
+
- CONTRIBUTING.md
|
134
135
|
- Gemfile
|
135
136
|
- Gemfile.lock
|
136
137
|
- MIT-LICENSE
|