Skip to content
This repository was archived by the owner on Aug 7, 2023. It is now read-only.

Commit 2531d61

Browse files
committed
Update the readme
Mainly remark-lint issues fixed. Split contributing out into its own file.
1 parent 8aa964e commit 2531d61

File tree

2 files changed

+29
-26
lines changed

2 files changed

+29
-26
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Contributing
2+
3+
If you would like to contribute enhancements or fixes, please do the following:
4+
5+
1. Fork the plugin repository.
6+
2. Hack on a separate topic branch created from the latest `master`.
7+
3. Commit and push the topic branch.
8+
4. Make a pull request.
9+
5. Welcome to the club!
10+
11+
Please note that modifications should follow these coding guidelines:
12+
13+
- Indent is 2 spaces.
14+
- Code should pass coffeelint linter.
15+
- Vertical whitespace helps readability, don’t be afraid to use it.
16+
17+
Thank you for helping out!

README.md

Lines changed: 12 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,26 @@
1-
linter-ruby
2-
=========================
1+
# linter-ruby
32

4-
This linter plugin for [Linter](https://github.com/AtomLinter/Linter) provides an interface to Ruby's builtin syntax analysis. It will be used with files that have the `Ruby` syntax.
3+
This linter plugin for [Linter](https://github.com/AtomLinter/Linter) provides
4+
an interface to Ruby's builtin syntax analysis. It will be used with files that
5+
have the `Ruby` syntax.
56

67
## Installation
7-
On first activation the plugin will install all dependencies automatically, you no longer have to worry about installing Linter.
8+
9+
On first activation the plugin will install all dependencies automatically, you
10+
no longer have to worry about installing Linter.
811

912
Just install this package and you'll be good to go.
1013

1114
## Settings
12-
You can configure linter-ruby by editing ~/.atom/config.cson (choose Open Your Config in Atom menu):
13-
```coffee
15+
16+
You can configure linter-ruby by editing `~/.atom/config.cson` (choose Open
17+
Your Config in Atom menu):
18+
19+
```coffeescript
1420
'linter-ruby':
1521
# ruby path. run `which ruby` to find the path.
1622
'rubyExecutablePath': null
1723

1824
# ignored extensions, ERB and markdown files by default.
1925
'ignoredExtensions': 'erb, md'
2026
```
21-
22-
## Contributing
23-
If you would like to contribute enhancements or fixes, please do the following:
24-
25-
1. Fork the plugin repository.
26-
1. Hack on a separate topic branch created from the latest `master`.
27-
1. Commit and push the topic branch.
28-
1. Make a pull request.
29-
1. welcome to the club
30-
31-
Please note that modifications should follow these coding guidelines:
32-
33-
- Indent is 2 spaces.
34-
- Code should pass coffeelint linter.
35-
- Vertical whitespace helps readability, don’t be afraid to use it.
36-
37-
Thank you for helping out!
38-
39-
## Donation
40-
[![Share the love!](https://chewbacco-stuff.s3.amazonaws.com/donate.png)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=KXUYS4ARNHCN8)

0 commit comments

Comments
 (0)