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

Commit b5c69bd

Browse files
committed
Update the readme
remark-lint fixes and splitting out the contributing section.
1 parent dea4a5e commit b5c69bd

File tree

2 files changed

+26
-23
lines changed

2 files changed

+26
-23
lines changed

CONTRIBUTING.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
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+
15+
- Code should pass [CoffeeLint](http://www.coffeelint.org/) with the provided
16+
`coffeelint.json`
17+
18+
- Vertical whitespace helps readability, don’t be afraid to use it.
19+
20+
**Thank you for helping out!**

README.md

+6-23
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,16 @@
1-
linter-csslint
2-
=========================
3-
[![Build Status](https://travis-ci.org/AtomLinter/linter-csslint.svg)](https://travis-ci.org/AtomLinter/linter-csslint)
1+
# linter-csslint [![Build Status](https://travis-ci.org/AtomLinter/linter-csslint.svg)](https://travis-ci.org/AtomLinter/linter-csslint)
42

53
This linter plugin for [Linter](https://github.com/AtomLinter/Linter) provides
64
an interface to [csslint](https://github.com/CSSLint/csslint). It will be used
7-
with files that have the CSS or HTML syntax.
5+
with files that have the "CSS" or "HTML" syntax.
86

97
## Installation
10-
If the `linter` is not already installed, it will be installed for you to provide
11-
a UI for the service this package provides.
8+
9+
If the `linter` is not already installed, it will be installed for you to
10+
provide a UI for the service this package provides.
1211

1312
### Plugin installation
13+
1414
```ShellSession
1515
apm install linter-csslint
1616
```
17-
18-
## Contributing
19-
If you would like to contribute enhancements or fixes, please do the following:
20-
21-
1. Fork the plugin repository.
22-
1. Hack on a separate topic branch created from the latest `master`.
23-
1. Commit and push the topic branch.
24-
1. Make a pull request.
25-
1. Welcome to the club!
26-
27-
Please note that modifications should follow these coding guidelines:
28-
29-
- Indent is 2 spaces.
30-
- Code should pass [CoffeeLint](http://www.coffeelint.org/) with the provided `coffeelint.json`
31-
- Vertical whitespace helps readability, don’t be afraid to use it.
32-
33-
**Thank you for helping out!**

0 commit comments

Comments
 (0)